Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/servicefabric

Index

Classes

Interfaces

Type aliases

Object literals

Type aliases

ApplicationDefinitionKind

ApplicationDefinitionKind: "Invalid" | "ServiceFabricApplicationDescription" | "Compose"

Defines values for ApplicationDefinitionKind. Possible values include: 'Invalid', 'ServiceFabricApplicationDescription', 'Compose'

readonly
enum

{string}

ApplicationEventUnion

Contains the possible cases for ApplicationEvent.

ApplicationPackageCleanupPolicy

ApplicationPackageCleanupPolicy: "Invalid" | "Default" | "Automatic" | "Manual"

Defines values for ApplicationPackageCleanupPolicy. Possible values include: 'Invalid', 'Default', 'Automatic', 'Manual'

readonly
enum

{string}

ApplicationScopedVolumeCreationParametersUnion

Contains the possible cases for ApplicationScopedVolumeCreationParameters.

ApplicationScopedVolumeKind

ApplicationScopedVolumeKind: "ServiceFabricVolumeDisk"

Defines values for ApplicationScopedVolumeKind. Possible values include: 'ServiceFabricVolumeDisk'

readonly
enum

{string}

ApplicationStatus

ApplicationStatus: "Invalid" | "Ready" | "Upgrading" | "Creating" | "Deleting" | "Failed"

Defines values for ApplicationStatus. Possible values include: 'Invalid', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed'

readonly
enum

{string}

ApplicationTypeDefinitionKind

ApplicationTypeDefinitionKind: "Invalid" | "ServiceFabricApplicationPackage" | "Compose"

Defines values for ApplicationTypeDefinitionKind. Possible values include: 'Invalid', 'ServiceFabricApplicationPackage', 'Compose'

readonly
enum

{string}

ApplicationTypeStatus

ApplicationTypeStatus: "Invalid" | "Provisioning" | "Available" | "Unprovisioning" | "Failed"

Defines values for ApplicationTypeStatus. Possible values include: 'Invalid', 'Provisioning', 'Available', 'Unprovisioning', 'Failed'

readonly
enum

{string}

AutoScalingMechanismKind

AutoScalingMechanismKind: "AddRemoveReplica"

Defines values for AutoScalingMechanismKind. Possible values include: 'AddRemoveReplica'

readonly
enum

{string}

AutoScalingMechanismUnion

Contains the possible cases for AutoScalingMechanism.

AutoScalingMetricKind

AutoScalingMetricKind: "Resource"

Defines values for AutoScalingMetricKind. Possible values include: 'Resource'

readonly
enum

{string}

AutoScalingMetricUnion

Contains the possible cases for AutoScalingMetric.

AutoScalingResourceMetricName

AutoScalingResourceMetricName: "cpu" | "memoryInGB"

Defines values for AutoScalingResourceMetricName. Possible values include: 'cpu', 'memoryInGB'

readonly
enum

{string}

AutoScalingTriggerKind

AutoScalingTriggerKind: "AverageLoad"

Defines values for AutoScalingTriggerKind. Possible values include: 'AverageLoad'

readonly
enum

{string}

AutoScalingTriggerUnion

Contains the possible cases for AutoScalingTrigger.

BackupConfigurationInfoUnion

Contains the possible cases for BackupConfigurationInfo.

BackupEntityKind

BackupEntityKind: "Invalid" | "Partition" | "Service" | "Application"

Defines values for BackupEntityKind. Possible values include: 'Invalid', 'Partition', 'Service', 'Application'

readonly
enum

{string}

BackupEntityUnion

Contains the possible cases for BackupEntity.

BackupPolicyScope

BackupPolicyScope: "Invalid" | "Partition" | "Service" | "Application"

Defines values for BackupPolicyScope. Possible values include: 'Invalid', 'Partition', 'Service', 'Application'

readonly
enum

{string}

BackupScheduleDescriptionUnion

Contains the possible cases for BackupScheduleDescription.

BackupScheduleFrequencyType

BackupScheduleFrequencyType: "Invalid" | "Daily" | "Weekly"

Defines values for BackupScheduleFrequencyType. Possible values include: 'Invalid', 'Daily', 'Weekly'

readonly
enum

{string}

BackupScheduleKind

BackupScheduleKind: "Invalid" | "TimeBased" | "FrequencyBased"

Defines values for BackupScheduleKind. Possible values include: 'Invalid', 'TimeBased', 'FrequencyBased'

readonly
enum

{string}

BackupState

BackupState: "Invalid" | "Accepted" | "BackupInProgress" | "Success" | "Failure" | "Timeout"

Defines values for BackupState. Possible values include: 'Invalid', 'Accepted', 'BackupInProgress', 'Success', 'Failure', 'Timeout'

readonly
enum

{string}

BackupStorageDescriptionUnion

Contains the possible cases for BackupStorageDescription.

BackupStorageKind

BackupStorageKind: "Invalid" | "FileShare" | "AzureBlobStore"

Defines values for BackupStorageKind. Possible values include: 'Invalid', 'FileShare', 'AzureBlobStore'

readonly
enum

{string}

BackupSuspensionScope

BackupSuspensionScope: "Invalid" | "Partition" | "Service" | "Application"

Defines values for BackupSuspensionScope. Possible values include: 'Invalid', 'Partition', 'Service', 'Application'

readonly
enum

{string}

BackupType

BackupType: "Invalid" | "Full" | "Incremental"

Defines values for BackupType. Possible values include: 'Invalid', 'Full', 'Incremental'

readonly
enum

{string}

CancelRepairTaskResponse

CancelRepairTaskResponse: RepairTaskUpdateInfo & object

Contains response data for the cancelRepairTask operation.

ChaosEventKind

ChaosEventKind: "Invalid" | "Started" | "ExecutingFaults" | "Waiting" | "ValidationFailed" | "TestError" | "Stopped"

Defines values for ChaosEventKind. Possible values include: 'Invalid', 'Started', 'ExecutingFaults', 'Waiting', 'ValidationFailed', 'TestError', 'Stopped'

readonly
enum

{string}

ChaosEventUnion

Contains the possible cases for ChaosEvent.

ChaosScheduleStatus

ChaosScheduleStatus: "Invalid" | "Stopped" | "Active" | "Expired" | "Pending"

Defines values for ChaosScheduleStatus. Possible values include: 'Invalid', 'Stopped', 'Active', 'Expired', 'Pending'

readonly
enum

{string}

ChaosStatus

ChaosStatus: "Invalid" | "Running" | "Stopped"

Defines values for ChaosStatus. Possible values include: 'Invalid', 'Running', 'Stopped'

readonly
enum

{string}

ClusterEventUnion

Contains the possible cases for ClusterEvent.

ComposeDeploymentStatus

ComposeDeploymentStatus: "Invalid" | "Provisioning" | "Creating" | "Ready" | "Unprovisioning" | "Deleting" | "Failed" | "Upgrading"

Defines values for ComposeDeploymentStatus. Possible values include: 'Invalid', 'Provisioning', 'Creating', 'Ready', 'Unprovisioning', 'Deleting', 'Failed', 'Upgrading'

readonly
enum

{string}

ComposeDeploymentUpgradeState

ComposeDeploymentUpgradeState: "Invalid" | "ProvisioningTarget" | "RollingForwardInProgress" | "RollingForwardPending" | "UnprovisioningCurrent" | "RollingForwardCompleted" | "RollingBackInProgress" | "UnprovisioningTarget" | "RollingBackCompleted" | "Failed"

Defines values for ComposeDeploymentUpgradeState. Possible values include: 'Invalid', 'ProvisioningTarget', 'RollingForwardInProgress', 'RollingForwardPending', 'UnprovisioningCurrent', 'RollingForwardCompleted', 'RollingBackInProgress', 'UnprovisioningTarget', 'RollingBackCompleted', 'Failed'

readonly
enum

{string}

CreateFabricDump

CreateFabricDump: "False" | "True"

Defines values for CreateFabricDump. Possible values include: 'False', 'True'

readonly
enum

{string}

CreateRepairTaskResponse

CreateRepairTaskResponse: RepairTaskUpdateInfo & object

Contains response data for the createRepairTask operation.

DataLossMode

DataLossMode: "Invalid" | "PartialDataLoss" | "FullDataLoss"

Defines values for DataLossMode. Possible values include: 'Invalid', 'PartialDataLoss', 'FullDataLoss'

readonly
enum

{string}

DayOfWeek

DayOfWeek: "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday"

Defines values for DayOfWeek. Possible values include: 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'

readonly
enum

{string}

DeactivationIntent

DeactivationIntent: "Pause" | "Restart" | "RemoveData"

Defines values for DeactivationIntent. Possible values include: 'Pause', 'Restart', 'RemoveData'

readonly
enum

{string}

DeployedApplicationStatus

DeployedApplicationStatus: "Invalid" | "Downloading" | "Activating" | "Active" | "Upgrading" | "Deactivating"

Defines values for DeployedApplicationStatus. Possible values include: 'Invalid', 'Downloading', 'Activating', 'Active', 'Upgrading', 'Deactivating'

readonly
enum

{string}

DeployedServiceReplicaDetailInfoUnion

Contains the possible cases for DeployedServiceReplicaDetailInfo.

DeployedServiceReplicaInfoUnion

Contains the possible cases for DeployedServiceReplicaInfo.

DeploymentStatus

DeploymentStatus: "Invalid" | "Downloading" | "Activating" | "Active" | "Upgrading" | "Deactivating"

Defines values for DeploymentStatus. Possible values include: 'Invalid', 'Downloading', 'Activating', 'Active', 'Upgrading', 'Deactivating'

readonly
enum

{string}

DiagnosticsSinkKind

DiagnosticsSinkKind: "Invalid" | "AzureInternalMonitoringPipeline"

Defines values for DiagnosticsSinkKind. Possible values include: 'Invalid', 'AzureInternalMonitoringPipeline'

readonly
enum

{string}

DiagnosticsSinkPropertiesUnion

Contains the possible cases for DiagnosticsSinkProperties.

EntityKind

EntityKind: "Invalid" | "Node" | "Partition" | "Service" | "Application" | "Replica" | "DeployedApplication" | "DeployedServicePackage" | "Cluster"

Defines values for EntityKind. Possible values include: 'Invalid', 'Node', 'Partition', 'Service', 'Application', 'Replica', 'DeployedApplication', 'DeployedServicePackage', 'Cluster'

readonly
enum

{string}

EntryPointStatus

EntryPointStatus: "Invalid" | "Pending" | "Starting" | "Started" | "Stopping" | "Stopped"

Defines values for EntryPointStatus. Possible values include: 'Invalid', 'Pending', 'Starting', 'Started', 'Stopping', 'Stopped'

readonly
enum

{string}

FabricErrorCodes

FabricErrorCodes: "FABRIC_E_INVALID_PARTITION_KEY" | "FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR" | "FABRIC_E_INVALID_ADDRESS" | "FABRIC_E_APPLICATION_NOT_UPGRADING" | "FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR" | "FABRIC_E_FABRIC_NOT_UPGRADING" | "FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR" | "FABRIC_E_INVALID_CONFIGURATION" | "FABRIC_E_INVALID_NAME_URI" | "FABRIC_E_PATH_TOO_LONG" | "FABRIC_E_KEY_TOO_LARGE" | "FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED" | "FABRIC_E_INVALID_ATOMIC_GROUP" | "FABRIC_E_VALUE_EMPTY" | "FABRIC_E_NODE_NOT_FOUND" | "FABRIC_E_APPLICATION_TYPE_NOT_FOUND" | "FABRIC_E_APPLICATION_NOT_FOUND" | "FABRIC_E_SERVICE_TYPE_NOT_FOUND" | "FABRIC_E_SERVICE_DOES_NOT_EXIST" | "FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND" | "FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND" | "FABRIC_E_PARTITION_NOT_FOUND" | "FABRIC_E_REPLICA_DOES_NOT_EXIST" | "FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST" | "FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND" | "FABRIC_E_DIRECTORY_NOT_FOUND" | "FABRIC_E_FABRIC_VERSION_NOT_FOUND" | "FABRIC_E_FILE_NOT_FOUND" | "FABRIC_E_NAME_DOES_NOT_EXIST" | "FABRIC_E_PROPERTY_DOES_NOT_EXIST" | "FABRIC_E_ENUMERATION_COMPLETED" | "FABRIC_E_SERVICE_MANIFEST_NOT_FOUND" | "FABRIC_E_KEY_NOT_FOUND" | "FABRIC_E_HEALTH_ENTITY_NOT_FOUND" | "FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS" | "FABRIC_E_APPLICATION_ALREADY_EXISTS" | "FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION" | "FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS" | "FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS" | "FABRIC_E_SERVICE_ALREADY_EXISTS" | "FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS" | "FABRIC_E_APPLICATION_TYPE_IN_USE" | "FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION" | "FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS" | "FABRIC_E_FABRIC_VERSION_IN_USE" | "FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS" | "FABRIC_E_NAME_ALREADY_EXISTS" | "FABRIC_E_NAME_NOT_EMPTY" | "FABRIC_E_PROPERTY_CHECK_FAILED" | "FABRIC_E_SERVICE_METADATA_MISMATCH" | "FABRIC_E_SERVICE_TYPE_MISMATCH" | "FABRIC_E_HEALTH_STALE_REPORT" | "FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED" | "FABRIC_E_NODE_HAS_NOT_STOPPED_YET" | "FABRIC_E_INSTANCE_ID_MISMATCH" | "FABRIC_E_VALUE_TOO_LARGE" | "FABRIC_E_NO_WRITE_QUORUM" | "FABRIC_E_NOT_PRIMARY" | "FABRIC_E_NOT_READY" | "FABRIC_E_RECONFIGURATION_PENDING" | "FABRIC_E_SERVICE_OFFLINE" | "E_ABORT" | "FABRIC_E_COMMUNICATION_ERROR" | "FABRIC_E_OPERATION_NOT_COMPLETE" | "FABRIC_E_TIMEOUT" | "FABRIC_E_NODE_IS_UP" | "E_FAIL" | "FABRIC_E_BACKUP_IS_ENABLED" | "FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH" | "FABRIC_E_INVALID_FOR_STATELESS_SERVICES" | "FABRIC_E_BACKUP_NOT_ENABLED" | "FABRIC_E_BACKUP_POLICY_NOT_EXISTING" | "FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING" | "FABRIC_E_BACKUP_IN_PROGRESS" | "FABRIC_E_RESTORE_IN_PROGRESS" | "FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING" | "FABRIC_E_INVALID_SERVICE_SCALING_POLICY" | "E_INVALIDARG" | "FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS" | "FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND" | "FABRIC_E_VOLUME_ALREADY_EXISTS" | "FABRIC_E_VOLUME_NOT_FOUND" | "SerializationError" | "FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR"

Defines values for FabricErrorCodes. Possible values include: 'FABRIC_E_INVALID_PARTITION_KEY', 'FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR', 'FABRIC_E_INVALID_ADDRESS', 'FABRIC_E_APPLICATION_NOT_UPGRADING', 'FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR', 'FABRIC_E_FABRIC_NOT_UPGRADING', 'FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR', 'FABRIC_E_INVALID_CONFIGURATION', 'FABRIC_E_INVALID_NAME_URI', 'FABRIC_E_PATH_TOO_LONG', 'FABRIC_E_KEY_TOO_LARGE', 'FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED', 'FABRIC_E_INVALID_ATOMIC_GROUP', 'FABRIC_E_VALUE_EMPTY', 'FABRIC_E_NODE_NOT_FOUND', 'FABRIC_E_APPLICATION_TYPE_NOT_FOUND', 'FABRIC_E_APPLICATION_NOT_FOUND', 'FABRIC_E_SERVICE_TYPE_NOT_FOUND', 'FABRIC_E_SERVICE_DOES_NOT_EXIST', 'FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND', 'FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND', 'FABRIC_E_PARTITION_NOT_FOUND', 'FABRIC_E_REPLICA_DOES_NOT_EXIST', 'FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST', 'FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND', 'FABRIC_E_DIRECTORY_NOT_FOUND', 'FABRIC_E_FABRIC_VERSION_NOT_FOUND', 'FABRIC_E_FILE_NOT_FOUND', 'FABRIC_E_NAME_DOES_NOT_EXIST', 'FABRIC_E_PROPERTY_DOES_NOT_EXIST', 'FABRIC_E_ENUMERATION_COMPLETED', 'FABRIC_E_SERVICE_MANIFEST_NOT_FOUND', 'FABRIC_E_KEY_NOT_FOUND', 'FABRIC_E_HEALTH_ENTITY_NOT_FOUND', 'FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS', 'FABRIC_E_APPLICATION_ALREADY_EXISTS', 'FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION', 'FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS', 'FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS', 'FABRIC_E_SERVICE_ALREADY_EXISTS', 'FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS', 'FABRIC_E_APPLICATION_TYPE_IN_USE', 'FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION', 'FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS', 'FABRIC_E_FABRIC_VERSION_IN_USE', 'FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS', 'FABRIC_E_NAME_ALREADY_EXISTS', 'FABRIC_E_NAME_NOT_EMPTY', 'FABRIC_E_PROPERTY_CHECK_FAILED', 'FABRIC_E_SERVICE_METADATA_MISMATCH', 'FABRIC_E_SERVICE_TYPE_MISMATCH', 'FABRIC_E_HEALTH_STALE_REPORT', 'FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED', 'FABRIC_E_NODE_HAS_NOT_STOPPED_YET', 'FABRIC_E_INSTANCE_ID_MISMATCH', 'FABRIC_E_VALUE_TOO_LARGE', 'FABRIC_E_NO_WRITE_QUORUM', 'FABRIC_E_NOT_PRIMARY', 'FABRIC_E_NOT_READY', 'FABRIC_E_RECONFIGURATION_PENDING', 'FABRIC_E_SERVICE_OFFLINE', 'E_ABORT', 'FABRIC_E_COMMUNICATION_ERROR', 'FABRIC_E_OPERATION_NOT_COMPLETE', 'FABRIC_E_TIMEOUT', 'FABRIC_E_NODE_IS_UP', 'E_FAIL', 'FABRIC_E_BACKUP_IS_ENABLED', 'FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH', 'FABRIC_E_INVALID_FOR_STATELESS_SERVICES', 'FABRIC_E_BACKUP_NOT_ENABLED', 'FABRIC_E_BACKUP_POLICY_NOT_EXISTING', 'FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING', 'FABRIC_E_BACKUP_IN_PROGRESS', 'FABRIC_E_RESTORE_IN_PROGRESS', 'FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING', 'FABRIC_E_INVALID_SERVICE_SCALING_POLICY', 'E_INVALIDARG', 'FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS', 'FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND', 'FABRIC_E_VOLUME_ALREADY_EXISTS', 'FABRIC_E_VOLUME_NOT_FOUND', 'SerializationError', 'FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR'

readonly
enum

{string}

FabricEventKind

FabricEventKind: "ClusterEvent" | "ContainerInstanceEvent" | "NodeEvent" | "ApplicationEvent" | "ServiceEvent" | "PartitionEvent" | "ReplicaEvent" | "PartitionAnalysisEvent" | "ApplicationCreated" | "ApplicationDeleted" | "ApplicationNewHealthReport" | "ApplicationHealthReportExpired" | "ApplicationUpgradeCompleted" | "ApplicationUpgradeDomainCompleted" | "ApplicationUpgradeRollbackCompleted" | "ApplicationUpgradeRollbackStarted" | "ApplicationUpgradeStarted" | "DeployedApplicationNewHealthReport" | "DeployedApplicationHealthReportExpired" | "ApplicationProcessExited" | "ApplicationContainerInstanceExited" | "NodeAborted" | "NodeAddedToCluster" | "NodeClosed" | "NodeDeactivateCompleted" | "NodeDeactivateStarted" | "NodeDown" | "NodeNewHealthReport" | "NodeHealthReportExpired" | "NodeOpenSucceeded" | "NodeOpenFailed" | "NodeRemovedFromCluster" | "NodeUp" | "PartitionNewHealthReport" | "PartitionHealthReportExpired" | "PartitionReconfigured" | "PartitionPrimaryMoveAnalysis" | "ServiceCreated" | "ServiceDeleted" | "ServiceNewHealthReport" | "ServiceHealthReportExpired" | "DeployedServicePackageNewHealthReport" | "DeployedServicePackageHealthReportExpired" | "StatefulReplicaNewHealthReport" | "StatefulReplicaHealthReportExpired" | "StatelessReplicaNewHealthReport" | "StatelessReplicaHealthReportExpired" | "ClusterNewHealthReport" | "ClusterHealthReportExpired" | "ClusterUpgradeCompleted" | "ClusterUpgradeDomainCompleted" | "ClusterUpgradeRollbackCompleted" | "ClusterUpgradeRollbackStarted" | "ClusterUpgradeStarted" | "ChaosStopped" | "ChaosStarted" | "ChaosCodePackageRestartScheduled" | "ChaosReplicaRemovalScheduled" | "ChaosPartitionSecondaryMoveScheduled" | "ChaosPartitionPrimaryMoveScheduled" | "ChaosReplicaRestartScheduled" | "ChaosNodeRestartScheduled"

Defines values for FabricEventKind. Possible values include: 'ClusterEvent', 'ContainerInstanceEvent', 'NodeEvent', 'ApplicationEvent', 'ServiceEvent', 'PartitionEvent', 'ReplicaEvent', 'PartitionAnalysisEvent', 'ApplicationCreated', 'ApplicationDeleted', 'ApplicationNewHealthReport', 'ApplicationHealthReportExpired', 'ApplicationUpgradeCompleted', 'ApplicationUpgradeDomainCompleted', 'ApplicationUpgradeRollbackCompleted', 'ApplicationUpgradeRollbackStarted', 'ApplicationUpgradeStarted', 'DeployedApplicationNewHealthReport', 'DeployedApplicationHealthReportExpired', 'ApplicationProcessExited', 'ApplicationContainerInstanceExited', 'NodeAborted', 'NodeAddedToCluster', 'NodeClosed', 'NodeDeactivateCompleted', 'NodeDeactivateStarted', 'NodeDown', 'NodeNewHealthReport', 'NodeHealthReportExpired', 'NodeOpenSucceeded', 'NodeOpenFailed', 'NodeRemovedFromCluster', 'NodeUp', 'PartitionNewHealthReport', 'PartitionHealthReportExpired', 'PartitionReconfigured', 'PartitionPrimaryMoveAnalysis', 'ServiceCreated', 'ServiceDeleted', 'ServiceNewHealthReport', 'ServiceHealthReportExpired', 'DeployedServicePackageNewHealthReport', 'DeployedServicePackageHealthReportExpired', 'StatefulReplicaNewHealthReport', 'StatefulReplicaHealthReportExpired', 'StatelessReplicaNewHealthReport', 'StatelessReplicaHealthReportExpired', 'ClusterNewHealthReport', 'ClusterHealthReportExpired', 'ClusterUpgradeCompleted', 'ClusterUpgradeDomainCompleted', 'ClusterUpgradeRollbackCompleted', 'ClusterUpgradeRollbackStarted', 'ClusterUpgradeStarted', 'ChaosStopped', 'ChaosStarted', 'ChaosCodePackageRestartScheduled', 'ChaosReplicaRemovalScheduled', 'ChaosPartitionSecondaryMoveScheduled', 'ChaosPartitionPrimaryMoveScheduled', 'ChaosReplicaRestartScheduled', 'ChaosNodeRestartScheduled'

readonly
enum

{string}

FabricEventUnion

Contains the possible cases for FabricEvent.

FabricReplicaStatus

FabricReplicaStatus: "Invalid" | "Down" | "Up"

Defines values for FabricReplicaStatus. Possible values include: 'Invalid', 'Down', 'Up'

readonly
enum

{string}

FailureAction

FailureAction: "Invalid" | "Rollback" | "Manual"

Defines values for FailureAction. Possible values include: 'Invalid', 'Rollback', 'Manual'

readonly
enum

{string}

FailureReason

FailureReason: "None" | "Interrupted" | "HealthCheck" | "UpgradeDomainTimeout" | "OverallUpgradeTimeout"

Defines values for FailureReason. Possible values include: 'None', 'Interrupted', 'HealthCheck', 'UpgradeDomainTimeout', 'OverallUpgradeTimeout'

readonly
enum

{string}

ForceApproveRepairTaskResponse

ForceApproveRepairTaskResponse: RepairTaskUpdateInfo & object

Contains response data for the forceApproveRepairTask operation.

GetAadMetadataResponse

GetAadMetadataResponse: AadMetadataObject & object

Contains response data for the getAadMetadata operation.

GetAllEntitiesBackedUpByPolicyResponse

GetAllEntitiesBackedUpByPolicyResponse: PagedBackupEntityList & object

Contains response data for the getAllEntitiesBackedUpByPolicy operation.

GetApplicationBackupConfigurationInfoResponse

GetApplicationBackupConfigurationInfoResponse: PagedBackupConfigurationInfoList & object

Contains response data for the getApplicationBackupConfigurationInfo operation.

GetApplicationBackupListResponse

GetApplicationBackupListResponse: PagedBackupInfoList & object

Contains response data for the getApplicationBackupList operation.

GetApplicationEventListResponse

GetApplicationEventListResponse: Array<ApplicationEventUnion> & object

Contains response data for the getApplicationEventList operation.

GetApplicationHealthResponse

GetApplicationHealthResponse: ApplicationHealth & object

Contains response data for the getApplicationHealth operation.

GetApplicationHealthUsingPolicyResponse

GetApplicationHealthUsingPolicyResponse: ApplicationHealth & object

Contains response data for the getApplicationHealthUsingPolicy operation.

GetApplicationInfoListResponse

GetApplicationInfoListResponse: PagedApplicationInfoList & object

Contains response data for the getApplicationInfoList operation.

GetApplicationInfoResponse

GetApplicationInfoResponse: ApplicationInfo & object

Contains response data for the getApplicationInfo operation.

GetApplicationLoadInfoResponse

GetApplicationLoadInfoResponse: ApplicationLoadInfo & object

Contains response data for the getApplicationLoadInfo operation.

GetApplicationManifestResponse

GetApplicationManifestResponse: ApplicationTypeManifest & object

Contains response data for the getApplicationManifest operation.

GetApplicationNameInfoResponse

GetApplicationNameInfoResponse: ApplicationNameInfo & object

Contains response data for the getApplicationNameInfo operation.

GetApplicationTypeInfoListByNameResponse

GetApplicationTypeInfoListByNameResponse: PagedApplicationTypeInfoList & object

Contains response data for the getApplicationTypeInfoListByName operation.

GetApplicationTypeInfoListResponse

GetApplicationTypeInfoListResponse: PagedApplicationTypeInfoList & object

Contains response data for the getApplicationTypeInfoList operation.

GetApplicationUpgradeResponse

GetApplicationUpgradeResponse: ApplicationUpgradeProgressInfo & object

Contains response data for the getApplicationUpgrade operation.

GetApplicationsEventListResponse

GetApplicationsEventListResponse: Array<ApplicationEventUnion> & object

Contains response data for the getApplicationsEventList operation.

GetBackupPolicyByNameResponse

GetBackupPolicyByNameResponse: BackupPolicyDescription & object

Contains response data for the getBackupPolicyByName operation.

GetBackupPolicyListResponse

GetBackupPolicyListResponse: PagedBackupPolicyDescriptionList & object

Contains response data for the getBackupPolicyList operation.

GetBackupsFromBackupLocationResponse

GetBackupsFromBackupLocationResponse: PagedBackupInfoList & object

Contains response data for the getBackupsFromBackupLocation operation.

GetChaosEventsResponse

GetChaosEventsResponse: ChaosEventsSegment & object

Contains response data for the getChaosEvents operation.

GetChaosResponse

GetChaosResponse: Chaos & object

Contains response data for the getChaos operation.

GetChaosScheduleResponse

GetChaosScheduleResponse: ChaosScheduleDescription & object

Contains response data for the getChaosSchedule operation.

GetClusterConfigurationResponse

GetClusterConfigurationResponse: ClusterConfiguration & object

Contains response data for the getClusterConfiguration operation.

GetClusterConfigurationUpgradeStatusResponse

GetClusterConfigurationUpgradeStatusResponse: ClusterConfigurationUpgradeStatusInfo & object

Contains response data for the getClusterConfigurationUpgradeStatus operation.

GetClusterEventListResponse

GetClusterEventListResponse: Array<ClusterEventUnion> & object

Contains response data for the getClusterEventList operation.

GetClusterHealthChunkResponse

GetClusterHealthChunkResponse: ClusterHealthChunk & object

Contains response data for the getClusterHealthChunk operation.

GetClusterHealthChunkUsingPolicyAndAdvancedFiltersResponse

GetClusterHealthChunkUsingPolicyAndAdvancedFiltersResponse: ClusterHealthChunk & object

Contains response data for the getClusterHealthChunkUsingPolicyAndAdvancedFilters operation.

GetClusterHealthResponse

GetClusterHealthResponse: ClusterHealth & object

Contains response data for the getClusterHealth operation.

GetClusterHealthUsingPolicyResponse

GetClusterHealthUsingPolicyResponse: ClusterHealth & object

Contains response data for the getClusterHealthUsingPolicy operation.

GetClusterLoadResponse

GetClusterLoadResponse: ClusterLoadInfo & object

Contains response data for the getClusterLoad operation.

GetClusterManifestResponse

GetClusterManifestResponse: ClusterManifest & object

Contains response data for the getClusterManifest operation.

GetClusterUpgradeProgressResponse

GetClusterUpgradeProgressResponse: ClusterUpgradeProgressObject & object

Contains response data for the getClusterUpgradeProgress operation.

GetClusterVersionResponse

GetClusterVersionResponse: ClusterVersion & object

Contains response data for the getClusterVersion operation.

GetComposeDeploymentStatusListResponse

GetComposeDeploymentStatusListResponse: PagedComposeDeploymentStatusInfoList & object

Contains response data for the getComposeDeploymentStatusList operation.

GetComposeDeploymentStatusResponse

GetComposeDeploymentStatusResponse: ComposeDeploymentStatusInfo & object

Contains response data for the getComposeDeploymentStatus operation.

GetComposeDeploymentUpgradeProgressResponse

GetComposeDeploymentUpgradeProgressResponse: ComposeDeploymentUpgradeProgressInfo & object

Contains response data for the getComposeDeploymentUpgradeProgress operation.

GetContainerLogsDeployedOnNodeResponse

GetContainerLogsDeployedOnNodeResponse: ContainerLogs & object

Contains response data for the getContainerLogsDeployedOnNode operation.

GetContainersEventListResponse

GetContainersEventListResponse: Array<ContainerInstanceEvent> & object

Contains response data for the getContainersEventList operation.

GetCorrelatedEventListResponse

GetCorrelatedEventListResponse: Array<FabricEventUnion> & object

Contains response data for the getCorrelatedEventList operation.

GetDataLossProgressResponse

GetDataLossProgressResponse: PartitionDataLossProgress & object

Contains response data for the getDataLossProgress operation.

GetDeployedApplicationHealthResponse

GetDeployedApplicationHealthResponse: DeployedApplicationHealth & object

Contains response data for the getDeployedApplicationHealth operation.

GetDeployedApplicationHealthUsingPolicyResponse

GetDeployedApplicationHealthUsingPolicyResponse: DeployedApplicationHealth & object

Contains response data for the getDeployedApplicationHealthUsingPolicy operation.

GetDeployedApplicationInfoListResponse

GetDeployedApplicationInfoListResponse: PagedDeployedApplicationInfoList & object

Contains response data for the getDeployedApplicationInfoList operation.

GetDeployedApplicationInfoResponse

GetDeployedApplicationInfoResponse: DeployedApplicationInfo & object

Contains response data for the getDeployedApplicationInfo operation.

GetDeployedCodePackageInfoListResponse

GetDeployedCodePackageInfoListResponse: Array<DeployedCodePackageInfo> & object

Contains response data for the getDeployedCodePackageInfoList operation.

GetDeployedServicePackageHealthResponse

GetDeployedServicePackageHealthResponse: DeployedServicePackageHealth & object

Contains response data for the getDeployedServicePackageHealth operation.

GetDeployedServicePackageHealthUsingPolicyResponse

GetDeployedServicePackageHealthUsingPolicyResponse: DeployedServicePackageHealth & object

Contains response data for the getDeployedServicePackageHealthUsingPolicy operation.

GetDeployedServicePackageInfoListByNameResponse

GetDeployedServicePackageInfoListByNameResponse: Array<DeployedServicePackageInfo> & object

Contains response data for the getDeployedServicePackageInfoListByName operation.

GetDeployedServicePackageInfoListResponse

GetDeployedServicePackageInfoListResponse: Array<DeployedServicePackageInfo> & object

Contains response data for the getDeployedServicePackageInfoList operation.

GetDeployedServiceReplicaDetailInfoByPartitionIdResponse

GetDeployedServiceReplicaDetailInfoByPartitionIdResponse: DeployedServiceReplicaDetailInfoUnion & object

Contains response data for the getDeployedServiceReplicaDetailInfoByPartitionId operation.

GetDeployedServiceReplicaDetailInfoResponse

GetDeployedServiceReplicaDetailInfoResponse: DeployedServiceReplicaDetailInfoUnion & object

Contains response data for the getDeployedServiceReplicaDetailInfo operation.

GetDeployedServiceReplicaInfoListResponse

GetDeployedServiceReplicaInfoListResponse: Array<DeployedServiceReplicaInfoUnion> & object

Contains response data for the getDeployedServiceReplicaInfoList operation.

GetDeployedServiceTypeInfoByNameResponse

GetDeployedServiceTypeInfoByNameResponse: Array<DeployedServiceTypeInfo> & object

Contains response data for the getDeployedServiceTypeInfoByName operation.

GetDeployedServiceTypeInfoListResponse

GetDeployedServiceTypeInfoListResponse: Array<DeployedServiceTypeInfo> & object

Contains response data for the getDeployedServiceTypeInfoList operation.

GetFaultOperationListResponse

GetFaultOperationListResponse: Array<OperationStatus> & object

Contains response data for the getFaultOperationList operation.

GetImageStoreContentResponse

GetImageStoreContentResponse: ImageStoreContent & object

Contains response data for the getImageStoreContent operation.

GetImageStoreFolderSizeResponse

GetImageStoreFolderSizeResponse: FolderSizeInfo & object

Contains response data for the getImageStoreFolderSize operation.

GetImageStoreRootContentResponse

GetImageStoreRootContentResponse: ImageStoreContent & object

Contains response data for the getImageStoreRootContent operation.

GetImageStoreRootFolderSizeResponse

GetImageStoreRootFolderSizeResponse: FolderSizeInfo & object

Contains response data for the getImageStoreRootFolderSize operation.

GetImageStoreUploadSessionByIdResponse

GetImageStoreUploadSessionByIdResponse: UploadSession & object

Contains response data for the getImageStoreUploadSessionById operation.

GetImageStoreUploadSessionByPathResponse

GetImageStoreUploadSessionByPathResponse: UploadSession & object

Contains response data for the getImageStoreUploadSessionByPath operation.

GetNodeEventListResponse

GetNodeEventListResponse: Array<NodeEventUnion> & object

Contains response data for the getNodeEventList operation.

GetNodeHealthResponse

GetNodeHealthResponse: NodeHealth & object

Contains response data for the getNodeHealth operation.

GetNodeHealthUsingPolicyResponse

GetNodeHealthUsingPolicyResponse: NodeHealth & object

Contains response data for the getNodeHealthUsingPolicy operation.

GetNodeInfoListResponse

GetNodeInfoListResponse: PagedNodeInfoList & object

Contains response data for the getNodeInfoList operation.

GetNodeInfoResponse

GetNodeInfoResponse: NodeInfo & object

Contains response data for the getNodeInfo operation.

GetNodeLoadInfoResponse

GetNodeLoadInfoResponse: NodeLoadInfo & object

Contains response data for the getNodeLoadInfo operation.

GetNodeTransitionProgressResponse

GetNodeTransitionProgressResponse: NodeTransitionProgress & object

Contains response data for the getNodeTransitionProgress operation.

GetNodesEventListResponse

GetNodesEventListResponse: Array<NodeEventUnion> & object

Contains response data for the getNodesEventList operation.

GetPartitionBackupConfigurationInfoResponse

GetPartitionBackupConfigurationInfoResponse: PartitionBackupConfigurationInfo & object

Contains response data for the getPartitionBackupConfigurationInfo operation.

GetPartitionBackupListResponse

GetPartitionBackupListResponse: PagedBackupInfoList & object

Contains response data for the getPartitionBackupList operation.

GetPartitionBackupProgressResponse

GetPartitionBackupProgressResponse: BackupProgressInfo & object

Contains response data for the getPartitionBackupProgress operation.

GetPartitionEventListResponse

GetPartitionEventListResponse: Array<PartitionEventUnion> & object

Contains response data for the getPartitionEventList operation.

GetPartitionHealthResponse

GetPartitionHealthResponse: PartitionHealth & object

Contains response data for the getPartitionHealth operation.

GetPartitionHealthUsingPolicyResponse

GetPartitionHealthUsingPolicyResponse: PartitionHealth & object

Contains response data for the getPartitionHealthUsingPolicy operation.

GetPartitionInfoListResponse

GetPartitionInfoListResponse: PagedServicePartitionInfoList & object

Contains response data for the getPartitionInfoList operation.

GetPartitionInfoResponse

GetPartitionInfoResponse: ServicePartitionInfoUnion & object

Contains response data for the getPartitionInfo operation.

GetPartitionLoadInformationResponse

GetPartitionLoadInformationResponse: PartitionLoadInformation & object

Contains response data for the getPartitionLoadInformation operation.

GetPartitionReplicaEventListResponse

GetPartitionReplicaEventListResponse: Array<ReplicaEventUnion> & object

Contains response data for the getPartitionReplicaEventList operation.

GetPartitionReplicasEventListResponse

GetPartitionReplicasEventListResponse: Array<ReplicaEventUnion> & object

Contains response data for the getPartitionReplicasEventList operation.

GetPartitionRestartProgressResponse

GetPartitionRestartProgressResponse: PartitionRestartProgress & object

Contains response data for the getPartitionRestartProgress operation.

GetPartitionRestoreProgressResponse

GetPartitionRestoreProgressResponse: RestoreProgressInfo & object

Contains response data for the getPartitionRestoreProgress operation.

GetPartitionsEventListResponse

GetPartitionsEventListResponse: Array<PartitionEventUnion> & object

Contains response data for the getPartitionsEventList operation.

GetPropertyInfoListResponse

GetPropertyInfoListResponse: PagedPropertyInfoList & object

Contains response data for the getPropertyInfoList operation.

GetPropertyInfoResponse

GetPropertyInfoResponse: PropertyInfo & object

Contains response data for the getPropertyInfo operation.

GetProvisionedFabricCodeVersionInfoListResponse

GetProvisionedFabricCodeVersionInfoListResponse: Array<FabricCodeVersionInfo> & object

Contains response data for the getProvisionedFabricCodeVersionInfoList operation.

GetProvisionedFabricConfigVersionInfoListResponse

GetProvisionedFabricConfigVersionInfoListResponse: Array<FabricConfigVersionInfo> & object

Contains response data for the getProvisionedFabricConfigVersionInfoList operation.

GetQuorumLossProgressResponse

GetQuorumLossProgressResponse: PartitionQuorumLossProgress & object

Contains response data for the getQuorumLossProgress operation.

GetRepairTaskListResponse

GetRepairTaskListResponse: Array<RepairTask> & object

Contains response data for the getRepairTaskList operation.

GetReplicaHealthResponse

GetReplicaHealthResponse: ReplicaHealthUnion & object

Contains response data for the getReplicaHealth operation.

GetReplicaHealthUsingPolicyResponse

GetReplicaHealthUsingPolicyResponse: ReplicaHealthUnion & object

Contains response data for the getReplicaHealthUsingPolicy operation.

GetReplicaInfoListResponse

GetReplicaInfoListResponse: PagedReplicaInfoList & object

Contains response data for the getReplicaInfoList operation.

GetReplicaInfoResponse

GetReplicaInfoResponse: ReplicaInfoUnion & object

Contains response data for the getReplicaInfo operation.

GetServiceBackupConfigurationInfoResponse

GetServiceBackupConfigurationInfoResponse: PagedBackupConfigurationInfoList & object

Contains response data for the getServiceBackupConfigurationInfo operation.

GetServiceBackupListResponse

GetServiceBackupListResponse: PagedBackupInfoList & object

Contains response data for the getServiceBackupList operation.

GetServiceDescriptionResponse

GetServiceDescriptionResponse: ServiceDescriptionUnion & object

Contains response data for the getServiceDescription operation.

GetServiceEventListResponse

GetServiceEventListResponse: Array<ServiceEventUnion> & object

Contains response data for the getServiceEventList operation.

GetServiceHealthResponse

GetServiceHealthResponse: ServiceHealth & object

Contains response data for the getServiceHealth operation.

GetServiceHealthUsingPolicyResponse

GetServiceHealthUsingPolicyResponse: ServiceHealth & object

Contains response data for the getServiceHealthUsingPolicy operation.

GetServiceInfoListResponse

GetServiceInfoListResponse: PagedServiceInfoList & object

Contains response data for the getServiceInfoList operation.

GetServiceInfoResponse

GetServiceInfoResponse: ServiceInfoUnion & object

Contains response data for the getServiceInfo operation.

GetServiceManifestResponse

GetServiceManifestResponse: ServiceTypeManifest & object

Contains response data for the getServiceManifest operation.

GetServiceNameInfoResponse

GetServiceNameInfoResponse: ServiceNameInfo & object

Contains response data for the getServiceNameInfo operation.

GetServiceTypeInfoByNameResponse

GetServiceTypeInfoByNameResponse: ServiceTypeInfo & object

Contains response data for the getServiceTypeInfoByName operation.

GetServiceTypeInfoListResponse

GetServiceTypeInfoListResponse: Array<ServiceTypeInfo> & object

Contains response data for the getServiceTypeInfoList operation.

GetServicesEventListResponse

GetServicesEventListResponse: Array<ServiceEventUnion> & object

Contains response data for the getServicesEventList operation.

GetSubNameInfoListResponse

GetSubNameInfoListResponse: PagedSubNameInfoList & object

Contains response data for the getSubNameInfoList operation.

GetUnplacedReplicaInformationResponse

GetUnplacedReplicaInformationResponse: UnplacedReplicaInformation & object

Contains response data for the getUnplacedReplicaInformation operation.

GetUpgradeOrchestrationServiceStateResponse

GetUpgradeOrchestrationServiceStateResponse: UpgradeOrchestrationServiceState & object

Contains response data for the getUpgradeOrchestrationServiceState operation.

HeaderMatchType

HeaderMatchType: "exact"

Defines values for HeaderMatchType. Possible values include: 'exact'

readonly
enum

{string}

HealthEvaluationKind

HealthEvaluationKind: "Invalid" | "Event" | "Replicas" | "Partitions" | "DeployedServicePackages" | "DeployedApplications" | "Services" | "Nodes" | "Applications" | "SystemApplication" | "UpgradeDomainDeployedApplications" | "UpgradeDomainNodes" | "Replica" | "Partition" | "DeployedServicePackage" | "DeployedApplication" | "Service" | "Node" | "Application" | "DeltaNodesCheck" | "UpgradeDomainDeltaNodesCheck" | "ApplicationTypeApplications"

Defines values for HealthEvaluationKind. Possible values include: 'Invalid', 'Event', 'Replicas', 'Partitions', 'DeployedServicePackages', 'DeployedApplications', 'Services', 'Nodes', 'Applications', 'SystemApplication', 'UpgradeDomainDeployedApplications', 'UpgradeDomainNodes', 'Replica', 'Partition', 'DeployedServicePackage', 'DeployedApplication', 'Service', 'Node', 'Application', 'DeltaNodesCheck', 'UpgradeDomainDeltaNodesCheck', 'ApplicationTypeApplications'

readonly
enum

{string}

HealthEvaluationUnion

Contains the possible cases for HealthEvaluation.

HealthState

HealthState: "Invalid" | "Ok" | "Warning" | "Error" | "Unknown"

Defines values for HealthState. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

readonly
enum

{string}

HostIsolationMode

HostIsolationMode: "None" | "Process" | "HyperV"

Defines values for HostIsolationMode. Possible values include: 'None', 'Process', 'HyperV'

readonly
enum

{string}

HostType

HostType: "Invalid" | "ExeHost" | "ContainerHost"

Defines values for HostType. Possible values include: 'Invalid', 'ExeHost', 'ContainerHost'

readonly
enum

{string}

ImpactLevel

ImpactLevel: "Invalid" | "None" | "Restart" | "RemoveData" | "RemoveNode"

Defines values for ImpactLevel. Possible values include: 'Invalid', 'None', 'Restart', 'RemoveData', 'RemoveNode'

readonly
enum

{string}

InvokeContainerApiResponse

InvokeContainerApiResponse: ContainerApiResponse & object

Contains response data for the invokeContainerApi operation.

InvokeInfrastructureCommandResponse

InvokeInfrastructureCommandResponse: object

Contains response data for the invokeInfrastructureCommand operation.

Type declaration

InvokeInfrastructureQueryResponse

InvokeInfrastructureQueryResponse: object

Contains response data for the invokeInfrastructureQuery operation.

Type declaration

MeshApplicationCreateOrUpdateResponse

MeshApplicationCreateOrUpdateResponse: ApplicationResourceDescription & object

Contains response data for the createOrUpdate operation.

MeshApplicationGetResponse

MeshApplicationGetResponse: ApplicationResourceDescription & object

Contains response data for the get operation.

MeshApplicationListResponse

MeshApplicationListResponse: PagedApplicationResourceDescriptionList & object

Contains response data for the list operation.

MeshCodePackageGetContainerLogsResponse

MeshCodePackageGetContainerLogsResponse: ContainerLogs & object

Contains response data for the getContainerLogs operation.

MeshGatewayCreateOrUpdateResponse

MeshGatewayCreateOrUpdateResponse: GatewayResourceDescription & object

Contains response data for the createOrUpdate operation.

MeshGatewayGetResponse

MeshGatewayGetResponse: GatewayResourceDescription & object

Contains response data for the get operation.

MeshGatewayListResponse

MeshGatewayListResponse: PagedGatewayResourceDescriptionList & object

Contains response data for the list operation.

MeshNetworkCreateOrUpdateResponse

MeshNetworkCreateOrUpdateResponse: NetworkResourceDescription & object

Contains response data for the createOrUpdate operation.

MeshNetworkGetResponse

MeshNetworkGetResponse: NetworkResourceDescription & object

Contains response data for the get operation.

MeshNetworkListResponse

MeshNetworkListResponse: PagedNetworkResourceDescriptionList & object

Contains response data for the list operation.

MeshSecretCreateOrUpdateResponse

MeshSecretCreateOrUpdateResponse: SecretResourceDescription & object

Contains response data for the createOrUpdate operation.

MeshSecretGetResponse

MeshSecretGetResponse: SecretResourceDescription & object

Contains response data for the get operation.

MeshSecretListResponse

MeshSecretListResponse: PagedSecretResourceDescriptionList & object

Contains response data for the list operation.

MeshSecretValueAddValueResponse

MeshSecretValueAddValueResponse: SecretValueResourceDescription & object

Contains response data for the addValue operation.

MeshSecretValueGetResponse

MeshSecretValueGetResponse: SecretValueResourceDescription & object

Contains response data for the get operation.

MeshSecretValueListResponse

MeshSecretValueListResponse: PagedSecretValueResourceDescriptionList & object

Contains response data for the list operation.

MeshSecretValueShowResponse

MeshSecretValueShowResponse: SecretValue & object

Contains response data for the show operation.

MeshServiceGetResponse

MeshServiceGetResponse: ServiceResourceDescription & object

Contains response data for the get operation.

MeshServiceListResponse

MeshServiceListResponse: PagedServiceResourceDescriptionList & object

Contains response data for the list operation.

MeshServiceReplicaGetResponse

MeshServiceReplicaGetResponse: ServiceReplicaDescription & object

Contains response data for the get operation.

MeshServiceReplicaListResponse

MeshServiceReplicaListResponse: PagedServiceReplicaDescriptionList & object

Contains response data for the list operation.

MeshVolumeCreateOrUpdateResponse

MeshVolumeCreateOrUpdateResponse: VolumeResourceDescription & object

Contains response data for the createOrUpdate operation.

MeshVolumeGetResponse

MeshVolumeGetResponse: VolumeResourceDescription & object

Contains response data for the get operation.

MeshVolumeListResponse

MeshVolumeListResponse: PagedVolumeResourceDescriptionList & object

Contains response data for the list operation.

MoveCost

MoveCost: "Zero" | "Low" | "Medium" | "High"

Defines values for MoveCost. Possible values include: 'Zero', 'Low', 'Medium', 'High'

readonly
enum

{string}

NetworkKind

NetworkKind: "Local"

Defines values for NetworkKind. Possible values include: 'Local'

readonly
enum

{string}

NetworkResourcePropertiesBaseUnion

Contains the possible cases for NetworkResourcePropertiesBase.

NetworkResourcePropertiesUnion

Contains the possible cases for NetworkResourceProperties.

NodeDeactivationIntent

NodeDeactivationIntent: "Invalid" | "Pause" | "Restart" | "RemoveData" | "RemoveNode"

Defines values for NodeDeactivationIntent. Possible values include: 'Invalid', 'Pause', 'Restart', 'RemoveData', 'RemoveNode'

readonly
enum

{string}

NodeDeactivationStatus

NodeDeactivationStatus: "None" | "SafetyCheckInProgress" | "SafetyCheckComplete" | "Completed"

Defines values for NodeDeactivationStatus. Possible values include: 'None', 'SafetyCheckInProgress', 'SafetyCheckComplete', 'Completed'

readonly
enum

{string}

NodeDeactivationTaskType

NodeDeactivationTaskType: "Invalid" | "Infrastructure" | "Repair" | "Client"

Defines values for NodeDeactivationTaskType. Possible values include: 'Invalid', 'Infrastructure', 'Repair', 'Client'

readonly
enum

{string}

NodeEventUnion

Contains the possible cases for NodeEvent.

NodeStatus

NodeStatus: "Invalid" | "Up" | "Down" | "Enabling" | "Disabling" | "Disabled" | "Unknown" | "Removed"

Defines values for NodeStatus. Possible values include: 'Invalid', 'Up', 'Down', 'Enabling', 'Disabling', 'Disabled', 'Unknown', 'Removed'

readonly
enum

{string}

NodeStatusFilter

NodeStatusFilter: "default" | "all" | "up" | "down" | "enabling" | "disabling" | "disabled" | "unknown" | "removed"

Defines values for NodeStatusFilter. Possible values include: 'default', 'all', 'up', 'down', 'enabling', 'disabling', 'disabled', 'unknown', 'removed'

readonly
enum

{string}

NodeTransitionType

NodeTransitionType: "Invalid" | "Start" | "Stop"

Defines values for NodeTransitionType. Possible values include: 'Invalid', 'Start', 'Stop'

readonly
enum

{string}

NodeUpgradePhase

NodeUpgradePhase: "Invalid" | "PreUpgradeSafetyCheck" | "Upgrading" | "PostUpgradeSafetyCheck"

Defines values for NodeUpgradePhase. Possible values include: 'Invalid', 'PreUpgradeSafetyCheck', 'Upgrading', 'PostUpgradeSafetyCheck'

readonly
enum

{string}

OperatingSystemType

OperatingSystemType: "Linux" | "Windows"

Defines values for OperatingSystemType. Possible values include: 'Linux', 'Windows'

readonly
enum

{string}

OperationState

OperationState: "Invalid" | "Running" | "RollingBack" | "Completed" | "Faulted" | "Cancelled" | "ForceCancelled"

Defines values for OperationState. Possible values include: 'Invalid', 'Running', 'RollingBack', 'Completed', 'Faulted', 'Cancelled', 'ForceCancelled'

readonly
enum

{string}

OperationType

OperationType: "Invalid" | "PartitionDataLoss" | "PartitionQuorumLoss" | "PartitionRestart" | "NodeTransition"

Defines values for OperationType. Possible values include: 'Invalid', 'PartitionDataLoss', 'PartitionQuorumLoss', 'PartitionRestart', 'NodeTransition'

readonly
enum

{string}

PackageSharingPolicyScope

PackageSharingPolicyScope: "None" | "All" | "Code" | "Config" | "Data"

Defines values for PackageSharingPolicyScope. Possible values include: 'None', 'All', 'Code', 'Config', 'Data'

readonly
enum

{string}

PartitionAccessStatus

PartitionAccessStatus: "Invalid" | "Granted" | "ReconfigurationPending" | "NotPrimary" | "NoWriteQuorum"

Defines values for PartitionAccessStatus. Possible values include: 'Invalid', 'Granted', 'ReconfigurationPending', 'NotPrimary', 'NoWriteQuorum'

readonly
enum

{string}

PartitionAnalysisEventUnion

Contains the possible cases for PartitionAnalysisEvent.

PartitionEventUnion

Contains the possible cases for PartitionEvent.

PartitionInformationUnion

Contains the possible cases for PartitionInformation.

PartitionSafetyCheckUnion

Contains the possible cases for PartitionSafetyCheck.

PartitionScheme

PartitionScheme: "Invalid" | "Singleton" | "UniformInt64Range" | "Named"

Defines values for PartitionScheme. Possible values include: 'Invalid', 'Singleton', 'UniformInt64Range', 'Named'

readonly
enum

{string}

PartitionSchemeDescriptionUnion

Contains the possible cases for PartitionSchemeDescription.

PropertyBatchInfoKind

PropertyBatchInfoKind: "Invalid" | "Successful" | "Failed"

Defines values for PropertyBatchInfoKind. Possible values include: 'Invalid', 'Successful', 'Failed'

readonly
enum

{string}

PropertyBatchInfoUnion

Contains the possible cases for PropertyBatchInfo.

PropertyBatchOperationKind

PropertyBatchOperationKind: "Invalid" | "Put" | "Get" | "CheckExists" | "CheckSequence" | "Delete" | "CheckValue"

Defines values for PropertyBatchOperationKind. Possible values include: 'Invalid', 'Put', 'Get', 'CheckExists', 'CheckSequence', 'Delete', 'CheckValue'

readonly
enum

{string}

PropertyBatchOperationUnion

Contains the possible cases for PropertyBatchOperation.

PropertyValueKind

PropertyValueKind: "Invalid" | "Binary" | "Int64" | "Double" | "String" | "Guid"

Defines values for PropertyValueKind. Possible values include: 'Invalid', 'Binary', 'Int64', 'Double', 'String', 'Guid'

readonly
enum

{string}

PropertyValueUnion

Contains the possible cases for PropertyValue.

ProvisionApplicationTypeDescriptionBaseUnion

Contains the possible cases for ProvisionApplicationTypeDescriptionBase.

ProvisionApplicationTypeKind

ProvisionApplicationTypeKind: "Invalid" | "ImageStorePath" | "ExternalStore"

Defines values for ProvisionApplicationTypeKind. Possible values include: 'Invalid', 'ImageStorePath', 'ExternalStore'

readonly
enum

{string}

QuorumLossMode

QuorumLossMode: "Invalid" | "QuorumReplicas" | "AllReplicas"

Defines values for QuorumLossMode. Possible values include: 'Invalid', 'QuorumReplicas', 'AllReplicas'

readonly
enum

{string}

ReconfigurationPhase

ReconfigurationPhase: "Unknown" | "None" | "Phase0" | "Phase1" | "Phase2" | "Phase3" | "Phase4" | "AbortPhaseZero"

Defines values for ReconfigurationPhase. Possible values include: 'Unknown', 'None', 'Phase0', 'Phase1', 'Phase2', 'Phase3', 'Phase4', 'AbortPhaseZero'

readonly
enum

{string}

ReconfigurationType

ReconfigurationType: "Unknown" | "SwapPrimary" | "Failover" | "Other"

Defines values for ReconfigurationType. Possible values include: 'Unknown', 'SwapPrimary', 'Failover', 'Other'

readonly
enum

{string}

RepairImpactDescriptionBaseUnion

RepairImpactDescriptionBaseUnion: RepairImpactDescriptionBase | NodeRepairImpactDescription

Contains the possible cases for RepairImpactDescriptionBase.

RepairImpactKind

RepairImpactKind: "Invalid" | "Node"

Defines values for RepairImpactKind. Possible values include: 'Invalid', 'Node'

readonly
enum

{string}

RepairTargetDescriptionBaseUnion

RepairTargetDescriptionBaseUnion: RepairTargetDescriptionBase | NodeRepairTargetDescription

Contains the possible cases for RepairTargetDescriptionBase.

RepairTargetKind

RepairTargetKind: "Invalid" | "Node"

Defines values for RepairTargetKind. Possible values include: 'Invalid', 'Node'

readonly
enum

{string}

RepairTaskHealthCheckState

RepairTaskHealthCheckState: "NotStarted" | "InProgress" | "Succeeded" | "Skipped" | "TimedOut"

Defines values for RepairTaskHealthCheckState. Possible values include: 'NotStarted', 'InProgress', 'Succeeded', 'Skipped', 'TimedOut'

readonly
enum

{string}

ReplicaEventUnion

Contains the possible cases for ReplicaEvent.

ReplicaHealthReportServiceKind

ReplicaHealthReportServiceKind: "Stateless" | "Stateful"

Defines values for ReplicaHealthReportServiceKind. Possible values include: 'Stateless', 'Stateful'

readonly
enum

{string}

ReplicaHealthStateUnion

Contains the possible cases for ReplicaHealthState.

ReplicaHealthUnion

Contains the possible cases for ReplicaHealth.

ReplicaInfoUnion

Contains the possible cases for ReplicaInfo.

ReplicaKind

ReplicaKind: "Invalid" | "KeyValueStore"

Defines values for ReplicaKind. Possible values include: 'Invalid', 'KeyValueStore'

readonly
enum

{string}

ReplicaRole

ReplicaRole: "Unknown" | "None" | "Primary" | "IdleSecondary" | "ActiveSecondary"

Defines values for ReplicaRole. Possible values include: 'Unknown', 'None', 'Primary', 'IdleSecondary', 'ActiveSecondary'

readonly
enum

{string}

ReplicaStatus

ReplicaStatus: "Invalid" | "InBuild" | "Standby" | "Ready" | "Down" | "Dropped"

Defines values for ReplicaStatus. Possible values include: 'Invalid', 'InBuild', 'Standby', 'Ready', 'Down', 'Dropped'

readonly
enum

{string}

ReplicaStatusBaseUnion

Contains the possible cases for ReplicaStatusBase.

ReplicatorOperationName

ReplicatorOperationName: "Invalid" | "None" | "Open" | "ChangeRole" | "UpdateEpoch" | "Close" | "Abort" | "OnDataLoss" | "WaitForCatchup" | "Build"

Defines values for ReplicatorOperationName. Possible values include: 'Invalid', 'None', 'Open', 'ChangeRole', 'UpdateEpoch', 'Close', 'Abort', 'OnDataLoss', 'WaitForCatchup', 'Build'

readonly
enum

{string}

ReplicatorStatusUnion

Contains the possible cases for ReplicatorStatus.

ResolveServiceResponse

ResolveServiceResponse: ResolvedServicePartition & object

Contains response data for the resolveService operation.

ResourceStatus

ResourceStatus: "Unknown" | "Ready" | "Upgrading" | "Creating" | "Deleting" | "Failed"

Defines values for ResourceStatus. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed'

readonly
enum

{string}

RestartPartitionMode

RestartPartitionMode: "Invalid" | "AllReplicasOrInstances" | "OnlyActiveSecondaries"

Defines values for RestartPartitionMode. Possible values include: 'Invalid', 'AllReplicasOrInstances', 'OnlyActiveSecondaries'

readonly
enum

{string}

RestoreState

RestoreState: "Invalid" | "Accepted" | "RestoreInProgress" | "Success" | "Failure" | "Timeout"

Defines values for RestoreState. Possible values include: 'Invalid', 'Accepted', 'RestoreInProgress', 'Success', 'Failure', 'Timeout'

readonly
enum

{string}

ResultStatus

ResultStatus: "Invalid" | "Succeeded" | "Cancelled" | "Interrupted" | "Failed" | "Pending"

Defines values for ResultStatus. Possible values include: 'Invalid', 'Succeeded', 'Cancelled', 'Interrupted', 'Failed', 'Pending'

readonly
enum

{string}

RetentionPolicyDescriptionUnion

Contains the possible cases for RetentionPolicyDescription.

RetentionPolicyType

RetentionPolicyType: "Basic" | "Invalid"

Defines values for RetentionPolicyType. Possible values include: 'Basic', 'Invalid'

readonly
enum

{string}

SafetyCheckKind

SafetyCheckKind: "Invalid" | "EnsureSeedNodeQuorum" | "EnsurePartitionQuorum" | "WaitForPrimaryPlacement" | "WaitForPrimarySwap" | "WaitForReconfiguration" | "WaitForInbuildReplica" | "EnsureAvailability"

Defines values for SafetyCheckKind. Possible values include: 'Invalid', 'EnsureSeedNodeQuorum', 'EnsurePartitionQuorum', 'WaitForPrimaryPlacement', 'WaitForPrimarySwap', 'WaitForReconfiguration', 'WaitForInbuildReplica', 'EnsureAvailability'

readonly
enum

{string}

SafetyCheckUnion

Contains the possible cases for SafetyCheck.

ScalingMechanismDescriptionUnion

Contains the possible cases for ScalingMechanismDescription.

ScalingMechanismKind

ScalingMechanismKind: "Invalid" | "PartitionInstanceCount" | "AddRemoveIncrementalNamedPartition"

Defines values for ScalingMechanismKind. Possible values include: 'Invalid', 'PartitionInstanceCount', 'AddRemoveIncrementalNamedPartition'

readonly
enum

{string}

ScalingTriggerDescriptionUnion

Contains the possible cases for ScalingTriggerDescription.

ScalingTriggerKind

ScalingTriggerKind: "Invalid" | "AveragePartitionLoad" | "AverageServiceLoad"

Defines values for ScalingTriggerKind. Possible values include: 'Invalid', 'AveragePartitionLoad', 'AverageServiceLoad'

readonly
enum

{string}

SecondaryReplicatorStatusUnion

Contains the possible cases for SecondaryReplicatorStatus.

SecretKind

SecretKind: "inlinedValue"

Defines values for SecretKind. Possible values include: 'inlinedValue'

readonly
enum

{string}

SecretResourcePropertiesBaseUnion

SecretResourcePropertiesBaseUnion: SecretResourcePropertiesBase | SecretResourcePropertiesUnion

Contains the possible cases for SecretResourcePropertiesBase.

SecretResourcePropertiesUnion

Contains the possible cases for SecretResourceProperties.

ServiceCorrelationScheme

ServiceCorrelationScheme: "Invalid" | "Affinity" | "AlignedAffinity" | "NonAlignedAffinity"

Defines values for ServiceCorrelationScheme. Possible values include: 'Invalid', 'Affinity', 'AlignedAffinity', 'NonAlignedAffinity'

readonly
enum

{string}

ServiceDescriptionUnion

Contains the possible cases for ServiceDescription.

ServiceEndpointRole

ServiceEndpointRole: "Invalid" | "Stateless" | "StatefulPrimary" | "StatefulSecondary"

Defines values for ServiceEndpointRole. Possible values include: 'Invalid', 'Stateless', 'StatefulPrimary', 'StatefulSecondary'

readonly
enum

{string}

ServiceEventUnion

Contains the possible cases for ServiceEvent.

ServiceInfoUnion

Contains the possible cases for ServiceInfo.

ServiceKind

ServiceKind: "Invalid" | "Stateless" | "Stateful"

Defines values for ServiceKind. Possible values include: 'Invalid', 'Stateless', 'Stateful'

readonly
enum

{string}

ServiceLoadMetricWeight

ServiceLoadMetricWeight: "Zero" | "Low" | "Medium" | "High"

Defines values for ServiceLoadMetricWeight. Possible values include: 'Zero', 'Low', 'Medium', 'High'

readonly
enum

{string}

ServiceOperationName

ServiceOperationName: "Unknown" | "None" | "Open" | "ChangeRole" | "Close" | "Abort"

Defines values for ServiceOperationName. Possible values include: 'Unknown', 'None', 'Open', 'ChangeRole', 'Close', 'Abort'

readonly
enum

{string}

ServicePackageActivationMode

ServicePackageActivationMode: "SharedProcess" | "ExclusiveProcess"

Defines values for ServicePackageActivationMode. Possible values include: 'SharedProcess', 'ExclusiveProcess'

readonly
enum

{string}

ServicePartitionInfoUnion

Contains the possible cases for ServicePartitionInfo.

ServicePartitionKind

ServicePartitionKind: "Invalid" | "Singleton" | "Int64Range" | "Named"

Defines values for ServicePartitionKind. Possible values include: 'Invalid', 'Singleton', 'Int64Range', 'Named'

readonly
enum

{string}

ServicePartitionStatus

ServicePartitionStatus: "Invalid" | "Ready" | "NotReady" | "InQuorumLoss" | "Reconfiguring" | "Deleting"

Defines values for ServicePartitionStatus. Possible values include: 'Invalid', 'Ready', 'NotReady', 'InQuorumLoss', 'Reconfiguring', 'Deleting'

readonly
enum

{string}

ServicePlacementPolicyDescriptionUnion

Contains the possible cases for ServicePlacementPolicyDescription.

ServicePlacementPolicyType

ServicePlacementPolicyType: "Invalid" | "InvalidDomain" | "RequireDomain" | "PreferPrimaryDomain" | "RequireDomainDistribution" | "NonPartiallyPlaceService"

Defines values for ServicePlacementPolicyType. Possible values include: 'Invalid', 'InvalidDomain', 'RequireDomain', 'PreferPrimaryDomain', 'RequireDomainDistribution', 'NonPartiallyPlaceService'

readonly
enum

{string}

ServiceStatus

ServiceStatus: "Unknown" | "Active" | "Upgrading" | "Deleting" | "Creating" | "Failed"

Defines values for ServiceStatus. Possible values include: 'Unknown', 'Active', 'Upgrading', 'Deleting', 'Creating', 'Failed'

readonly
enum

{string}

ServiceTypeDescriptionUnion

Contains the possible cases for ServiceTypeDescription.

ServiceTypeRegistrationStatus

ServiceTypeRegistrationStatus: "Invalid" | "Disabled" | "Enabled" | "Registered"

Defines values for ServiceTypeRegistrationStatus. Possible values include: 'Invalid', 'Disabled', 'Enabled', 'Registered'

readonly
enum

{string}

ServiceUpdateDescriptionUnion

Contains the possible cases for ServiceUpdateDescription.

SetUpgradeOrchestrationServiceStateResponse

SetUpgradeOrchestrationServiceStateResponse: UpgradeOrchestrationServiceStateSummary & object

Contains response data for the setUpgradeOrchestrationServiceState operation.

SizeTypes

SizeTypes: "Small" | "Medium" | "Large"

Defines values for SizeTypes. Possible values include: 'Small', 'Medium', 'Large'

readonly
enum

{string}

State

State: "Invalid" | "Created" | "Claimed" | "Preparing" | "Approved" | "Executing" | "Restoring" | "Completed"

Defines values for State. Possible values include: 'Invalid', 'Created', 'Claimed', 'Preparing', 'Approved', 'Executing', 'Restoring', 'Completed'

readonly
enum

{string}

SubmitPropertyBatchResponse

SubmitPropertyBatchResponse: PropertyBatchInfoUnion & object

Contains response data for the submitPropertyBatch operation.

UpdateRepairExecutionStateResponse

UpdateRepairExecutionStateResponse: RepairTaskUpdateInfo & object

Contains response data for the updateRepairExecutionState operation.

UpdateRepairTaskHealthPolicyResponse

UpdateRepairTaskHealthPolicyResponse: RepairTaskUpdateInfo & object

Contains response data for the updateRepairTaskHealthPolicy operation.

UpgradeDomainState

UpgradeDomainState: "Invalid" | "Pending" | "InProgress" | "Completed"

Defines values for UpgradeDomainState. Possible values include: 'Invalid', 'Pending', 'InProgress', 'Completed'

readonly
enum

{string}

UpgradeKind

UpgradeKind: "Invalid" | "Rolling"

Defines values for UpgradeKind. Possible values include: 'Invalid', 'Rolling'

readonly
enum

{string}

UpgradeMode

UpgradeMode: "Invalid" | "UnmonitoredAuto" | "UnmonitoredManual" | "Monitored"

Defines values for UpgradeMode. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'

readonly
enum

{string}

UpgradeSortOrder

UpgradeSortOrder: "Invalid" | "Default" | "Numeric" | "Lexicographical" | "ReverseNumeric" | "ReverseLexicographical"

Defines values for UpgradeSortOrder. Possible values include: 'Invalid', 'Default', 'Numeric', 'Lexicographical', 'ReverseNumeric', 'ReverseLexicographical'

readonly
enum

{string}

UpgradeState

UpgradeState: "Invalid" | "RollingBackInProgress" | "RollingBackCompleted" | "RollingForwardPending" | "RollingForwardInProgress" | "RollingForwardCompleted" | "Failed"

Defines values for UpgradeState. Possible values include: 'Invalid', 'RollingBackInProgress', 'RollingBackCompleted', 'RollingForwardPending', 'RollingForwardInProgress', 'RollingForwardCompleted', 'Failed'

readonly
enum

{string}

UpgradeType

UpgradeType: "Invalid" | "Rolling" | "Rolling_ForceRestart"

Defines values for UpgradeType. Possible values include: 'Invalid', 'Rolling', 'Rolling_ForceRestart'

readonly
enum

{string}

VolumeProvider

VolumeProvider: "SFAzureFile"

Defines values for VolumeProvider. Possible values include: 'SFAzureFile'

readonly
enum

{string}

Object literals

Const AadMetadata

AadMetadata: object

Azure Active Directory metadata used for secured connection to cluster.

Optional authority

authority: undefined | string

The AAD authority url.

Optional client

client: undefined | string

The AAD client application Id.

Optional cluster

cluster: undefined | string

The AAD cluster application Id.

Optional login

login: undefined | string

The AAD login url.

Optional redirect

redirect: undefined | string

The client application redirect address.

Optional tenant

tenant: undefined | string

The AAD tenant Id.

serializedName

serializedName: string = "AadMetadata"

type

type: object

className

className: string = "AadMetadata"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authority

authority: object

serializedName

serializedName: string = "authority"

type

type: object

name

name: "String" = "String"

client

client: object

serializedName

serializedName: string = "client"

type

type: object

name

name: "String" = "String"

cluster

cluster: object

serializedName

serializedName: string = "cluster"

type

type: object

name

name: "String" = "String"

login

login: object

serializedName

serializedName: string = "login"

type

type: object

name

name: "String" = "String"

redirect

redirect: object

serializedName

serializedName: string = "redirect"

type

type: object

name

name: "String" = "String"

tenant

tenant: object

serializedName

serializedName: string = "tenant"

type

type: object

name

name: "String" = "String"

Const AadMetadataObject

AadMetadataObject: object

Azure Active Directory metadata object used for secured connection to cluster.

Optional metadata

metadata: AadMetadata

Azure Active Directory metadata used for secured connection to cluster.

serializedName

serializedName: string = "AadMetadataObject"

Optional type

type: object

The client authentication method.

className

className: string = "AadMetadataObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

className

className: string = "AadMetadata"

name

name: "Composite" = "Composite"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const AddRemoveIncrementalNamedPartitionScalingMechanism

AddRemoveIncrementalNamedPartitionScalingMechanism: object

Represents a scaling mechanism for adding or removing named partitions of a stateless service. Partition names are in the format '0','1''N-1'

kind

kind: "AddRemoveIncrementalNamedPartition"

Polymorphic Discriminator

maxPartitionCount

maxPartitionCount: number

Maximum number of named partitions of the service.

minPartitionCount

minPartitionCount: number

Minimum number of named partitions of the service.

scaleIncrement

scaleIncrement: number

The number of instances to add or remove during a scaling operation.

serializedName

serializedName: string = "AddRemoveIncrementalNamedPartition"

type

type: object

className

className: string = "AddRemoveIncrementalNamedPartitionScalingMechanism"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ScalingMechanismDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "ScalingMechanismDescription"

modelProperties

modelProperties: object

maxPartitionCount

maxPartitionCount: object

required

required: true = true

serializedName

serializedName: string = "MaxPartitionCount"

type

type: object

name

name: "Number" = "Number"

minPartitionCount

minPartitionCount: object

required

required: true = true

serializedName

serializedName: string = "MinPartitionCount"

type

type: object

name

name: "Number" = "Number"

scaleIncrement

scaleIncrement: object

required

required: true = true

serializedName

serializedName: string = "ScaleIncrement"

type

type: object

name

name: "Number" = "Number"

Const AddRemoveReplicaScalingMechanism

AddRemoveReplicaScalingMechanism: object

Describes the horizontal auto scaling mechanism that adds or removes replicas (containers or container groups).

kind

kind: "AddRemoveReplica"

Polymorphic Discriminator

maxCount

maxCount: number

Maximum number of containers (scale up won't be performed above this number).

minCount

minCount: number

Minimum number of containers (scale down won't be performed below this number).

scaleIncrement

scaleIncrement: number

Each time auto scaling is performed, this number of containers will be added or removed.

serializedName

serializedName: string = "AddRemoveReplica"

type

type: object

className

className: string = "AddRemoveReplicaScalingMechanism"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = AutoScalingMechanism.type.polymorphicDiscriminator

uberParent

uberParent: string = "AutoScalingMechanism"

modelProperties

modelProperties: object

maxCount

maxCount: object

required

required: true = true

serializedName

serializedName: string = "maxCount"

type

type: object

name

name: "Number" = "Number"

minCount

minCount: object

required

required: true = true

serializedName

serializedName: string = "minCount"

type

type: object

name

name: "Number" = "Number"

scaleIncrement

scaleIncrement: object

required

required: true = true

serializedName

serializedName: string = "scaleIncrement"

type

type: object

name

name: "Number" = "Number"

Const AnalysisEventMetadata

AnalysisEventMetadata: object

Metadata about an Analysis Event.

Optional delay

delay: undefined | string

The analysis delay.

Optional duration

duration: undefined | string

The duration of analysis.

serializedName

serializedName: string = "AnalysisEventMetadata"

type

type: object

className

className: string = "AnalysisEventMetadata"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

delay

delay: object

serializedName

serializedName: string = "Delay"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

duration

duration: object

serializedName

serializedName: string = "Duration"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const ApplicationBackupConfigurationInfo

ApplicationBackupConfigurationInfo: object

Backup configuration information for a specific Service Fabric application specifying what backup policy is being applied and suspend description, if any.

Optional applicationName

applicationName: undefined | string

The name of the application, including the 'fabric:' URI scheme.

kind

kind: "Application"

Polymorphic Discriminator

Optional policyInheritedFrom

policyInheritedFrom: BackupPolicyScope

Specifies the scope at which the backup policy is applied. Possible values include: 'Invalid', 'Partition', 'Service', 'Application'

Optional policyName

policyName: undefined | string

The name of the backup policy which is applicable to this Service Fabric application or service or partition.

Optional suspensionInfo

suspensionInfo: BackupSuspensionInfo

Describes the backup suspension details.

serializedName

serializedName: string = "Application"

type

type: object

className

className: string = "ApplicationBackupConfigurationInfo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = BackupConfigurationInfo.type.polymorphicDiscriminator

uberParent

uberParent: string = "BackupConfigurationInfo"

modelProperties

modelProperties: object

applicationName

applicationName: object

serializedName

serializedName: string = "ApplicationName"

type

type: object

name

name: "String" = "String"

Const ApplicationBackupEntity

ApplicationBackupEntity: object

Identifies the Service Fabric application which is being backed up.

Optional applicationName

applicationName: undefined | string

The name of the application, including the 'fabric:' URI scheme.

entityKind

entityKind: "Application"

Polymorphic Discriminator

serializedName

serializedName: string = "Application"

type

type: object

className

className: string = "ApplicationBackupEntity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = BackupEntity.type.polymorphicDiscriminator

uberParent

uberParent: string = "BackupEntity"

modelProperties

modelProperties: object

applicationName

applicationName: object

serializedName

serializedName: string = "ApplicationName"

type

type: object

name

name: "String" = "String"

Const ApplicationCapacityDescription

ApplicationCapacityDescription: object

Describes capacity information for services of this application. This description can be used for describing the following.

  • Reserving the capacity for the services on the nodes
  • Limiting the total number of nodes that services of this application can run on
  • Limiting the custom capacity metrics to limit the total consumption of this metric by the services of this application

Optional applicationMetrics

applicationMetrics: ApplicationMetricDescription[]

List of application capacity metric description.

Optional maximumNodes

maximumNodes: undefined | number

The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node. Default value: 0.

Optional minimumNodes

minimumNodes: undefined | number

The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property.

serializedName

serializedName: string = "ApplicationCapacityDescription"

type

type: object

className

className: string = "ApplicationCapacityDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationMetrics

applicationMetrics: object

serializedName

serializedName: string = "ApplicationMetrics"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationMetricDescription"

name

name: "Composite" = "Composite"

maximumNodes

maximumNodes: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "MaximumNodes"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

minimumNodes

minimumNodes: object

serializedName

serializedName: string = "MinimumNodes"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

Const ApplicationContainerInstanceExitedEvent

ApplicationContainerInstanceExitedEvent: object

Container Exited event.

applicationId

applicationId: string

The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

Optional category

category: undefined | string

The category of event.

codePackageName

codePackageName: string

Name of Code package.

containerName

containerName: string

Name of Container.

entryPointType

entryPointType: string

Type of EntryPoint.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

exitCode

exitCode: number

Exit code of process.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

hostId

hostId: string

Host Id.

imageName

imageName: string

Name of Container image.

isExclusive

isExclusive: boolean

Indicates IsExclusive flag.

kind

kind: "ApplicationContainerInstanceExited"

Polymorphic Discriminator

serviceName

serviceName: string

Name of Service.

servicePackageActivationId

servicePackageActivationId: string

Activation Id of Service package.

servicePackageName

servicePackageName: string

Name of Service package.

startTime

startTime: Date

Start time of process.

timeStamp

timeStamp: Date

The time event was logged.

unexpectedTermination

unexpectedTermination: boolean

Indicates if termination is unexpected.

serializedName

serializedName: string = "ApplicationContainerInstanceExited"

type

type: object

className

className: string = "ApplicationContainerInstanceExitedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

codePackageName

codePackageName: object

required

required: true = true

serializedName

serializedName: string = "CodePackageName"

type

type: object

name

name: "String" = "String"

containerName

containerName: object

required

required: true = true

serializedName

serializedName: string = "ContainerName"

type

type: object

name

name: "String" = "String"

entryPointType

entryPointType: object

required

required: true = true

serializedName

serializedName: string = "EntryPointType"

type

type: object

name

name: "String" = "String"

exitCode

exitCode: object

required

required: true = true

serializedName

serializedName: string = "ExitCode"

type

type: object

name

name: "Number" = "Number"

hostId

hostId: object

required

required: true = true

serializedName

serializedName: string = "HostId"

type

type: object

name

name: "String" = "String"

imageName

imageName: object

required

required: true = true

serializedName

serializedName: string = "ImageName"

type

type: object

name

name: "String" = "String"

isExclusive

isExclusive: object

required

required: true = true

serializedName

serializedName: string = "IsExclusive"

type

type: object

name

name: "Boolean" = "Boolean"

serviceName

serviceName: object

required

required: true = true

serializedName

serializedName: string = "ServiceName"

type

type: object

name

name: "String" = "String"

servicePackageActivationId

servicePackageActivationId: object

required

required: true = true

serializedName

serializedName: string = "ServicePackageActivationId"

type

type: object

name

name: "String" = "String"

servicePackageName

servicePackageName: object

required

required: true = true

serializedName

serializedName: string = "ServicePackageName"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

required

required: true = true

serializedName

serializedName: string = "StartTime"

type

type: object

name

name: "DateTime" = "DateTime"

unexpectedTermination

unexpectedTermination: object

required

required: true = true

serializedName

serializedName: string = "UnexpectedTermination"

type

type: object

name

name: "Boolean" = "Boolean"

Const ApplicationCreatedEvent

ApplicationCreatedEvent: object

Application Created event.

applicationDefinitionKind

applicationDefinitionKind: string

Application definition kind.

applicationId

applicationId: string

The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

applicationTypeName

applicationTypeName: string

Application type name.

applicationTypeVersion

applicationTypeVersion: string

Application type version.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ApplicationCreated"

Polymorphic Discriminator

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ApplicationCreated"

type

type: object

className

className: string = "ApplicationCreatedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

applicationDefinitionKind

applicationDefinitionKind: object

required

required: true = true

serializedName

serializedName: string = "ApplicationDefinitionKind"

type

type: object

name

name: "String" = "String"

applicationTypeName

applicationTypeName: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeName"

type

type: object

name

name: "String" = "String"

applicationTypeVersion

applicationTypeVersion: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeVersion"

type

type: object

name

name: "String" = "String"

Const ApplicationDeletedEvent

ApplicationDeletedEvent: object

Application Deleted event.

applicationId

applicationId: string

The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

applicationTypeName

applicationTypeName: string

Application type name.

applicationTypeVersion

applicationTypeVersion: string

Application type version.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ApplicationDeleted"

Polymorphic Discriminator

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ApplicationDeleted"

type

type: object

className

className: string = "ApplicationDeletedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

applicationTypeName

applicationTypeName: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeName"

type

type: object

name

name: "String" = "String"

applicationTypeVersion

applicationTypeVersion: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeVersion"

type

type: object

name

name: "String" = "String"

Const ApplicationDescription

ApplicationDescription: object

Describes a Service Fabric application.

Optional applicationCapacity

applicationCapacity: ApplicationCapacityDescription

Describes capacity information for services of this application. This description can be used for describing the following.

  • Reserving the capacity for the services on the nodes
  • Limiting the total number of nodes that services of this application can run on
  • Limiting the custom capacity metrics to limit the total consumption of this metric by the services of this application

Optional managedApplicationIdentity

managedApplicationIdentity: ManagedApplicationIdentityDescription

Managed application identity description.

name

name: string

The name of the application, including the 'fabric:' URI scheme.

Optional parameterList

parameterList: ApplicationParameter[]

List of application parameters with overridden values from their default values specified in the application manifest.

typeName

typeName: string

The application type name as defined in the application manifest.

typeVersion

typeVersion: string

The version of the application type as defined in the application manifest.

serializedName

serializedName: string = "ApplicationDescription"

type

type: object

className

className: string = "ApplicationDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationCapacity

applicationCapacity: object

serializedName

serializedName: string = "ApplicationCapacity"

type

type: object

className

className: string = "ApplicationCapacityDescription"

name

name: "Composite" = "Composite"

managedApplicationIdentity

managedApplicationIdentity: object

serializedName

serializedName: string = "ManagedApplicationIdentity"

type

type: object

className

className: string = "ManagedApplicationIdentityDescription"

name

name: "Composite" = "Composite"

name

name: object

required

required: true = true

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

parameterList

parameterList: object

serializedName

serializedName: string = "ParameterList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationParameter"

name

name: "Composite" = "Composite"

typeName

typeName: object

required

required: true = true

serializedName

serializedName: string = "TypeName"

type

type: object

name

name: "String" = "String"

typeVersion

typeVersion: object

required

required: true = true

serializedName

serializedName: string = "TypeVersion"

type

type: object

name

name: "String" = "String"

Const ApplicationEvent

ApplicationEvent: object

Represents the base for all Application Events.

applicationId

applicationId: string

The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ApplicationEvent"

Polymorphic Discriminator

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ApplicationEvent"

type

type: object

className

className: string = "ApplicationEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

applicationId

applicationId: object

required

required: true = true

serializedName

serializedName: string = "ApplicationId"

type

type: object

name

name: "String" = "String"

Const ApplicationHealth

ApplicationHealth: object

Represents the health of the application. Contains the application aggregated health state and the service and deployed application health states.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional deployedApplicationHealthStates

deployedApplicationHealthStates: DeployedApplicationHealthState[]

Deployed application health states as found in the health store.

Optional healthEvents

healthEvents: HealthEvent[]

The list of health events reported on the entity.

Optional healthStatistics

healthStatistics: HealthStatistics

Shows the health statistics for all children types of the queried entity.

Optional name

name: undefined | string

The name of the application, including the 'fabric:' URI scheme.

Optional serviceHealthStates

serviceHealthStates: ServiceHealthState[]

Service health states as found in the health store.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.

serializedName

serializedName: string = "ApplicationHealth"

type

type: object

className

className: string = "ApplicationHealth"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

deployedApplicationHealthStates

deployedApplicationHealthStates: object

serializedName

serializedName: string = "DeployedApplicationHealthStates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DeployedApplicationHealthState"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

serviceHealthStates

serviceHealthStates: object

serializedName

serializedName: string = "ServiceHealthStates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceHealthState"

name

name: "Composite" = "Composite"

Const ApplicationHealthEvaluation

ApplicationHealthEvaluation: object

Represents health evaluation for an application, containing information about the data and the algorithm used by the health store to evaluate health.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional applicationName

applicationName: undefined | string

The name of the application, including the 'fabric:' URI scheme.

Optional description

description: undefined | string

Description of the health evaluation, which represents a summary of the evaluation process.

kind

kind: "Application"

Polymorphic Discriminator

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

List of unhealthy evaluations that led to the current aggregated health state of the application. The types of the unhealthy evaluations can be DeployedApplicationsHealthEvaluation, ServicesHealthEvaluation or EventHealthEvaluation.

serializedName

serializedName: string = "Application"

type

type: object

className

className: string = "ApplicationHealthEvaluation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = HealthEvaluation.type.polymorphicDiscriminator

uberParent

uberParent: string = "HealthEvaluation"

modelProperties

modelProperties: object

applicationName

applicationName: object

serializedName

serializedName: string = "ApplicationName"

type

type: object

name

name: "String" = "String"

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

Const ApplicationHealthPolicies

ApplicationHealthPolicies: object

Defines the application health policy map used to evaluate the health of an application or one of its children entities.

Optional applicationHealthPolicyMap

applicationHealthPolicyMap: ApplicationHealthPolicyMapItem[]

The wrapper that contains the map with application health policies used to evaluate specific applications in the cluster.

serializedName

serializedName: string = "ApplicationHealthPolicies"

type

type: object

className

className: string = "ApplicationHealthPolicies"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationHealthPolicyMap

applicationHealthPolicyMap: object

serializedName

serializedName: string = "ApplicationHealthPolicyMap"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationHealthPolicyMapItem"

name

name: "Composite" = "Composite"

Const ApplicationHealthPolicy

ApplicationHealthPolicy: object

Defines a health policy used to evaluate the health of an application or one of its children entities.

Optional considerWarningAsError

considerWarningAsError: undefined | false | true

Indicates whether warnings are treated with the same severity as errors. Default value: false.

Optional defaultServiceTypeHealthPolicy

defaultServiceTypeHealthPolicy: ServiceTypeHealthPolicy

The health policy used by default to evaluate the health of a service type.

Optional maxPercentUnhealthyDeployedApplications

maxPercentUnhealthyDeployedApplications: undefined | number

The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. Default value: 0.

Optional serviceTypeHealthPolicyMap

serviceTypeHealthPolicyMap: ServiceTypeHealthPolicyMapItem[]

The map with service type health policy per service type name. The map is empty by default.

serializedName

serializedName: string = "ApplicationHealthPolicy"

type

type: object

className

className: string = "ApplicationHealthPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

considerWarningAsError

considerWarningAsError: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "ConsiderWarningAsError"

type

type: object

name

name: "Boolean" = "Boolean"

defaultServiceTypeHealthPolicy

defaultServiceTypeHealthPolicy: object

serializedName

serializedName: string = "DefaultServiceTypeHealthPolicy"

type

type: object

className

className: string = "ServiceTypeHealthPolicy"

name

name: "Composite" = "Composite"

maxPercentUnhealthyDeployedApplications

maxPercentUnhealthyDeployedApplications: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "MaxPercentUnhealthyDeployedApplications"

type

type: object

name

name: "Number" = "Number"

serviceTypeHealthPolicyMap

serviceTypeHealthPolicyMap: object

serializedName

serializedName: string = "ServiceTypeHealthPolicyMap"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceTypeHealthPolicyMapItem"

name

name: "Composite" = "Composite"

Const ApplicationHealthPolicyMapItem

ApplicationHealthPolicyMapItem: object

Defines an item in ApplicationHealthPolicyMap.

key

key: string

The key of the application health policy map item. This is the name of the application.

value

The value of the application health policy map item. This is the ApplicationHealthPolicy for this application.

serializedName

serializedName: string = "ApplicationHealthPolicyMapItem"

type

type: object

className

className: string = "ApplicationHealthPolicyMapItem"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

key

key: object

required

required: true = true

serializedName

serializedName: string = "Key"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "Value"

type

type: object

className

className: string = "ApplicationHealthPolicy"

name

name: "Composite" = "Composite"

Const ApplicationHealthReportExpiredEvent

ApplicationHealthReportExpiredEvent: object

Application Health Report Expired event.

applicationId

applicationId: string

The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

applicationInstanceId

applicationInstanceId: number

Id of Application instance.

Optional category

category: undefined | string

The category of event.

description

description: string

Description of report.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

healthState

healthState: string

Describes the property health state.

kind

kind: "ApplicationHealthReportExpired"

Polymorphic Discriminator

property

property: string

Describes the property.

removeWhenExpired

removeWhenExpired: boolean

Indicates the removal when it expires.

sequenceNumber

sequenceNumber: number

Sequence number of report.

sourceId

sourceId: string

Id of report source.

sourceUtcTimestamp

sourceUtcTimestamp: Date

Source time.

timeStamp

timeStamp: Date

The time event was logged.

timeToLiveMs

timeToLiveMs: number

Time to live in milli-seconds.

serializedName

serializedName: string = "ApplicationHealthReportExpired"

type

type: object

className

className: string = "ApplicationHealthReportExpiredEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

applicationInstanceId

applicationInstanceId: object

required

required: true = true

serializedName

serializedName: string = "ApplicationInstanceId"

type

type: object

name

name: "Number" = "Number"

description

description: object

required

required: true = true

serializedName

serializedName: string = "Description"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

required

required: true = true

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

property

property: object

required

required: true = true

serializedName

serializedName: string = "Property"

type

type: object

name

name: "String" = "String"

removeWhenExpired

removeWhenExpired: object

required

required: true = true

serializedName

serializedName: string = "RemoveWhenExpired"

type

type: object

name

name: "Boolean" = "Boolean"

sequenceNumber

sequenceNumber: object

required

required: true = true

serializedName

serializedName: string = "SequenceNumber"

type

type: object

name

name: "Number" = "Number"

sourceId

sourceId: object

required

required: true = true

serializedName

serializedName: string = "SourceId"

type

type: object

name

name: "String" = "String"

sourceUtcTimestamp

sourceUtcTimestamp: object

required

required: true = true

serializedName

serializedName: string = "SourceUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

timeToLiveMs

timeToLiveMs: object

required

required: true = true

serializedName

serializedName: string = "TimeToLiveMs"

type

type: object

name

name: "Number" = "Number"

Const ApplicationHealthState

ApplicationHealthState: object

Represents the health state of an application, which contains the application identifier and the aggregated health state.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional name

name: undefined | string

The name of the application, including the 'fabric:' URI scheme.

serializedName

serializedName: string = "ApplicationHealthState"

type

type: object

className

className: string = "ApplicationHealthState"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

Const ApplicationHealthStateChunk

ApplicationHealthStateChunk: object

Represents the health state chunk of a application. The application health state chunk contains the application name, its aggregated health state and any children services and deployed applications that respect the filters in cluster health chunk query description.

Optional applicationName

applicationName: undefined | string

The name of the application, including the 'fabric:' URI scheme.

Optional applicationTypeName

applicationTypeName: undefined | string

The application type name as defined in the application manifest.

Optional deployedApplicationHealthStateChunks

deployedApplicationHealthStateChunks: DeployedApplicationHealthStateChunkList

The list of deployed application health state chunks in the cluster that respect the filters in the cluster health chunk query description.

Optional healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional serviceHealthStateChunks

serviceHealthStateChunks: ServiceHealthStateChunkList

The list of service health state chunks in the cluster that respect the filters in the cluster health chunk query description.

serializedName

serializedName: string = "ApplicationHealthStateChunk"

type

type: object

className

className: string = "ApplicationHealthStateChunk"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationName

applicationName: object

serializedName

serializedName: string = "ApplicationName"

type

type: object

name

name: "String" = "String"

applicationTypeName

applicationTypeName: object

serializedName

serializedName: string = "ApplicationTypeName"

type

type: object

name

name: "String" = "String"

deployedApplicationHealthStateChunks

deployedApplicationHealthStateChunks: object

serializedName

serializedName: string = "DeployedApplicationHealthStateChunks"

type

type: object

className

className: string = "DeployedApplicationHealthStateChunkList"

name

name: "Composite" = "Composite"

serviceHealthStateChunks

serviceHealthStateChunks: object

serializedName

serializedName: string = "ServiceHealthStateChunks"

type

type: object

className

className: string = "ServiceHealthStateChunkList"

name

name: "Composite" = "Composite"

Const ApplicationHealthStateChunkList

ApplicationHealthStateChunkList: object

The list of application health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.

Optional items

The list of application health state chunks that respect the input filters in the chunk query.

Optional totalCount

totalCount: undefined | number

Total number of entity health state objects that match the specified filters from the cluster health chunk query description.

serializedName

serializedName: string = "ApplicationHealthStateChunkList"

type

type: object

className

className: string = "ApplicationHealthStateChunkList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationHealthStateChunk"

name

name: "Composite" = "Composite"

Const ApplicationHealthStateFilter

ApplicationHealthStateFilter: object

Defines matching criteria to determine whether a application should be included in the cluster health chunk. One filter can match zero, one or multiple applications, depending on its properties.

Optional applicationNameFilter

applicationNameFilter: undefined | string

The name of the application that matches the filter, as a fabric uri. The filter is applied only to the specified application, if it exists. If the application doesn't exist, no application is returned in the cluster health chunk based on this filter. If the application exists, it is included in the cluster health chunk if it respects the other filter properties. If not specified, all applications are matched against the other filter members, like health state filter.

Optional applicationTypeNameFilter

applicationTypeNameFilter: undefined | string

The name of the application type that matches the filter. If specified, the filter is applied only to applications of the selected application type, if any exists. If no applications of the specified application type exists, no application is returned in the cluster health chunk based on this filter. Each application of the specified application type is included in the cluster health chunk if it respects the other filter properties. If not specified, all applications are matched against the other filter members, like health state filter.

Optional deployedApplicationFilters

deployedApplicationFilters: DeployedApplicationHealthStateFilter[]

Defines a list of filters that specify which deployed applications to be included in the returned cluster health chunk as children of the application. The deployed applications are returned only if the parent application matches a filter. If the list is empty, no deployed applications are returned. All the deployed applications are used to evaluate the parent application aggregated health state, regardless of the input filters. The application filter may specify multiple deployed application filters. For example, it can specify a filter to return all deployed applications with health state Error and another filter to always include a deployed application on a specified node.

Optional healthStateFilter

healthStateFilter: undefined | number

The filter for the health state of the applications. It allows selecting applications if they match the desired health states. The possible values are integer value of one of the following health states. Only applications that match the filter are returned. All applications are used to evaluate the cluster aggregated health state. If not specified, default value is None, unless the application name or the application type name are specified. If the filter has default value and application name is specified, the matching application is returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6, it matches applications with HealthState value of OK (2) and Warning (4).

  • Default - Default value. Matches any HealthState. The value is zero.
  • None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.
  • Ok - Filter that matches input with HealthState value Ok. The value is 2.
  • Warning - Filter that matches input with HealthState value Warning. The value is 4.
  • Error - Filter that matches input with HealthState value Error. The value is 8.
  • All - Filter that matches input with any HealthState value. The value is 65535. Default value: 0.

Optional serviceFilters

serviceFilters: ServiceHealthStateFilter[]

Defines a list of filters that specify which services to be included in the returned cluster health chunk as children of the application. The services are returned only if the parent application matches a filter. If the list is empty, no services are returned. All the services are used to evaluate the parent application aggregated health state, regardless of the input filters. The application filter may specify multiple service filters. For example, it can specify a filter to return all services with health state Error and another filter to always include a service identified by its service name.

serializedName

serializedName: string = "ApplicationHealthStateFilter"

type

type: object

className

className: string = "ApplicationHealthStateFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationNameFilter

applicationNameFilter: object

serializedName

serializedName: string = "ApplicationNameFilter"

type

type: object

name

name: "String" = "String"

applicationTypeNameFilter

applicationTypeNameFilter: object

serializedName

serializedName: string = "ApplicationTypeNameFilter"

type

type: object

name

name: "String" = "String"

deployedApplicationFilters

deployedApplicationFilters: object

serializedName

serializedName: string = "DeployedApplicationFilters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DeployedApplicationHealthStateFilter"

name

name: "Composite" = "Composite"

healthStateFilter

healthStateFilter: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "HealthStateFilter"

type

type: object

name

name: "Number" = "Number"

serviceFilters

serviceFilters: object

serializedName

serializedName: string = "ServiceFilters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceHealthStateFilter"

name

name: "Composite" = "Composite"

Const ApplicationInfo

ApplicationInfo: object

Information about a Service Fabric application.

Optional applicationDefinitionKind

applicationDefinitionKind: ApplicationDefinitionKind

The mechanism used to define a Service Fabric application. Possible values include: 'Invalid', 'ServiceFabricApplicationDescription', 'Compose'

Optional healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional id

id: undefined | string

The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

Optional name

name: undefined | string

The name of the application, including the 'fabric:' URI scheme.

Optional parameters

parameters: ApplicationParameter[]

List of application parameters with overridden values from their default values specified in the application manifest.

Optional status

The status of the application. Possible values include: 'Invalid', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed'

Optional typeName

typeName: undefined | string

The application type name as defined in the application manifest.

Optional typeVersion

typeVersion: undefined | string

The version of the application type as defined in the application manifest.

serializedName

serializedName: string = "ApplicationInfo"

type

type: object

className

className: string = "ApplicationInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationDefinitionKind

applicationDefinitionKind: object

serializedName

serializedName: string = "ApplicationDefinitionKind"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

id

id: object

serializedName

serializedName: string = "Id"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

parameters

parameters: object

serializedName

serializedName: string = "Parameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationParameter"

name

name: "Composite" = "Composite"

status

status: object

serializedName

serializedName: string = "Status"

type

type: object

name

name: "String" = "String"

typeName

typeName: object

serializedName

serializedName: string = "TypeName"

type

type: object

name

name: "String" = "String"

typeVersion

typeVersion: object

serializedName

serializedName: string = "TypeVersion"

type

type: object

name

name: "String" = "String"

Const ApplicationLoadInfo

ApplicationLoadInfo: object

Load Information about a Service Fabric application.

Optional applicationLoadMetricInformation

applicationLoadMetricInformation: ApplicationMetricDescription[]

List of application capacity metric description.

Optional id

id: undefined | string

The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

Optional maximumNodes

maximumNodes: undefined | number

The maximum number of nodes where this application can be instantiated. It is the number of nodes this application is allowed to span. For applications that do not have application capacity defined this value will be zero.

Optional minimumNodes

minimumNodes: undefined | number

The minimum number of nodes for this application. It is the number of nodes where Service Fabric will reserve Capacity in the cluster which equals to ReservedLoad * MinimumNodes for this Application instance. For applications that do not have application capacity defined this value will be zero.

Optional nodeCount

nodeCount: undefined | number

The number of nodes on which this application is instantiated. For applications that do not have application capacity defined this value will be zero.

serializedName

serializedName: string = "ApplicationLoadInfo"

type

type: object

className

className: string = "ApplicationLoadInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationLoadMetricInformation

applicationLoadMetricInformation: object

serializedName

serializedName: string = "ApplicationLoadMetricInformation"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationMetricDescription"

name

name: "Composite" = "Composite"

id

id: object

serializedName

serializedName: string = "Id"

type

type: object

name

name: "String" = "String"

maximumNodes

maximumNodes: object

serializedName

serializedName: string = "MaximumNodes"

type

type: object

name

name: "Number" = "Number"

minimumNodes

minimumNodes: object

serializedName

serializedName: string = "MinimumNodes"

type

type: object

name

name: "Number" = "Number"

nodeCount

nodeCount: object

serializedName

serializedName: string = "NodeCount"

type

type: object

name

name: "Number" = "Number"

Const ApplicationMetricDescription

ApplicationMetricDescription: object

Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.

Optional maximumCapacity

maximumCapacity: undefined | number

The maximum node capacity for Service Fabric application. This is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value. If set to zero, capacity for this metric is unlimited on each node. When creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity. When updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.

Optional name

name: undefined | string

The name of the metric.

Optional reservationCapacity

reservationCapacity: undefined | number

The node reservation capacity for Service Fabric application. This is the amount of load which is reserved on nodes which have instances of this application. If MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application. If set to zero, no capacity is reserved for this metric. When setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric.

Optional totalApplicationCapacity

totalApplicationCapacity: undefined | number

The total metric capacity for Service Fabric application. This is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value. When creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value.

serializedName

serializedName: string = "ApplicationMetricDescription"

type

type: object

className

className: string = "ApplicationMetricDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

maximumCapacity

maximumCapacity: object

serializedName

serializedName: string = "MaximumCapacity"

type

type: object

name

name: "Number" = "Number"

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

reservationCapacity

reservationCapacity: object

serializedName

serializedName: string = "ReservationCapacity"

type

type: object

name

name: "Number" = "Number"

totalApplicationCapacity

totalApplicationCapacity: object

serializedName

serializedName: string = "TotalApplicationCapacity"

type

type: object

name

name: "Number" = "Number"

Const ApplicationNameInfo

ApplicationNameInfo: object

Information about the application name.

Optional id

id: undefined | string

The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

Optional name

name: undefined | string

The name of the application, including the 'fabric:' URI scheme.

serializedName

serializedName: string = "ApplicationNameInfo"

type

type: object

className

className: string = "ApplicationNameInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "Id"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

Const ApplicationNewHealthReportEvent

ApplicationNewHealthReportEvent: object

Application Health Report Created event.

applicationId

applicationId: string

The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

applicationInstanceId

applicationInstanceId: number

Id of Application instance.

Optional category

category: undefined | string

The category of event.

description

description: string

Description of report.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

healthState

healthState: string

Describes the property health state.

kind

kind: "ApplicationNewHealthReport"

Polymorphic Discriminator

property

property: string

Describes the property.

removeWhenExpired

removeWhenExpired: boolean

Indicates the removal when it expires.

sequenceNumber

sequenceNumber: number

Sequence number of report.

sourceId

sourceId: string

Id of report source.

sourceUtcTimestamp

sourceUtcTimestamp: Date

Source time.

timeStamp

timeStamp: Date

The time event was logged.

timeToLiveMs

timeToLiveMs: number

Time to live in milli-seconds.

serializedName

serializedName: string = "ApplicationNewHealthReport"

type

type: object

className

className: string = "ApplicationNewHealthReportEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

applicationInstanceId

applicationInstanceId: object

required

required: true = true

serializedName

serializedName: string = "ApplicationInstanceId"

type

type: object

name

name: "Number" = "Number"

description

description: object

required

required: true = true

serializedName

serializedName: string = "Description"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

required

required: true = true

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

property

property: object

required

required: true = true

serializedName

serializedName: string = "Property"

type

type: object

name

name: "String" = "String"

removeWhenExpired

removeWhenExpired: object

required

required: true = true

serializedName

serializedName: string = "RemoveWhenExpired"

type

type: object

name

name: "Boolean" = "Boolean"

sequenceNumber

sequenceNumber: object

required

required: true = true

serializedName

serializedName: string = "SequenceNumber"

type

type: object

name

name: "Number" = "Number"

sourceId

sourceId: object

required

required: true = true

serializedName

serializedName: string = "SourceId"

type

type: object

name

name: "String" = "String"

sourceUtcTimestamp

sourceUtcTimestamp: object

required

required: true = true

serializedName

serializedName: string = "SourceUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

timeToLiveMs

timeToLiveMs: object

required

required: true = true

serializedName

serializedName: string = "TimeToLiveMs"

type

type: object

name

name: "Number" = "Number"

Const ApplicationParameter

ApplicationParameter: object

Describes an application parameter override to be applied when creating or upgrading an application.

key

key: string

The name of the parameter.

value

value: string

The value of the parameter.

serializedName

serializedName: string = "ApplicationParameter"

type

type: object

className

className: string = "ApplicationParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

key

key: object

required

required: true = true

serializedName

serializedName: string = "Key"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "Value"

type

type: object

name

name: "String" = "String"

Const ApplicationProcessExitedEvent

ApplicationProcessExitedEvent: object

Process Exited event.

applicationId

applicationId: string

The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

Optional category

category: undefined | string

The category of event.

codePackageName

codePackageName: string

Name of Code package.

entryPointType

entryPointType: string

Type of EntryPoint.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

exeName

exeName: string

Name of executable.

exitCode

exitCode: number

Exit code of process.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

hostId

hostId: string

Host Id.

isExclusive

isExclusive: boolean

Indicates IsExclusive flag.

kind

kind: "ApplicationProcessExited"

Polymorphic Discriminator

processId

processId: number

Process Id.

serviceName

serviceName: string

Name of Service.

servicePackageActivationId

servicePackageActivationId: string

Activation Id of Service package.

servicePackageName

servicePackageName: string

Name of Service package.

startTime

startTime: Date

Start time of process.

timeStamp

timeStamp: Date

The time event was logged.

unexpectedTermination

unexpectedTermination: boolean

Indicates if termination is unexpected.

serializedName

serializedName: string = "ApplicationProcessExited"

type

type: object

className

className: string = "ApplicationProcessExitedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

codePackageName

codePackageName: object

required

required: true = true

serializedName

serializedName: string = "CodePackageName"

type

type: object

name

name: "String" = "String"

entryPointType

entryPointType: object

required

required: true = true

serializedName

serializedName: string = "EntryPointType"

type

type: object

name

name: "String" = "String"

exeName

exeName: object

required

required: true = true

serializedName

serializedName: string = "ExeName"

type

type: object

name

name: "String" = "String"

exitCode

exitCode: object

required

required: true = true

serializedName

serializedName: string = "ExitCode"

type

type: object

name

name: "Number" = "Number"

hostId

hostId: object

required

required: true = true

serializedName

serializedName: string = "HostId"

type

type: object

name

name: "String" = "String"

isExclusive

isExclusive: object

required

required: true = true

serializedName

serializedName: string = "IsExclusive"

type

type: object

name

name: "Boolean" = "Boolean"

processId

processId: object

required

required: true = true

serializedName

serializedName: string = "ProcessId"

type

type: object

name

name: "Number" = "Number"

serviceName

serviceName: object

required

required: true = true

serializedName

serializedName: string = "ServiceName"

type

type: object

name

name: "String" = "String"

servicePackageActivationId

servicePackageActivationId: object

required

required: true = true

serializedName

serializedName: string = "ServicePackageActivationId"

type

type: object

name

name: "String" = "String"

servicePackageName

servicePackageName: object

required

required: true = true

serializedName

serializedName: string = "ServicePackageName"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

required

required: true = true

serializedName

serializedName: string = "StartTime"

type

type: object

name

name: "DateTime" = "DateTime"

unexpectedTermination

unexpectedTermination: object

required

required: true = true

serializedName

serializedName: string = "UnexpectedTermination"

type

type: object

name

name: "Boolean" = "Boolean"

Const ApplicationResourceDescription

ApplicationResourceDescription: object

This type describes a application resource.

Optional debugParams

debugParams: undefined | string

Internal - used by Visual Studio to setup the debugging session on the local development environment.

Optional description

description: undefined | string

User readable description of the application.

Optional diagnostics

Describes the diagnostics definition and usage for an application resource.

Optional healthState

healthState: HealthState

Describes the health state of an application resource. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' NOTE: This property will not be serialized. It can only be populated by the server.

Optional identity

Describes the identity of the application.

name

name: string

Name of the Application resource.

Optional serviceNames

serviceNames: string[]

Names of the services in the application. NOTE: This property will not be serialized. It can only be populated by the server.

Optional services

Describes the services in the application. This property is used to create or modify services of the application. On get only the name of the service is returned. The service description can be obtained by querying for the service resource.

Optional status

Status of the application. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional statusDetails

statusDetails: undefined | string

Gives additional information about the current status of the application. NOTE: This property will not be serialized. It can only be populated by the server.

Optional unhealthyEvaluation

unhealthyEvaluation: undefined | string

When the application's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the application is marked unhealthy. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ApplicationResourceDescription"

type

type: object

className

className: string = "ApplicationResourceDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

debugParams

debugParams: object

serializedName

serializedName: string = "properties.debugParams"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

diagnostics

diagnostics: object

serializedName

serializedName: string = "properties.diagnostics"

type

type: object

className

className: string = "DiagnosticsDescription"

name

name: "Composite" = "Composite"

healthState

healthState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.healthState"

type

type: object

name

name: "String" = "String"

identity

identity: object

serializedName

serializedName: string = "identity"

type

type: object

className

className: string = "IdentityDescription"

name

name: "Composite" = "Composite"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

serviceNames

serviceNames: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.serviceNames"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

services

services: object

serializedName

serializedName: string = "properties.services"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceResourceDescription"

name

name: "Composite" = "Composite"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

statusDetails

statusDetails: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.statusDetails"

type

type: object

name

name: "String" = "String"

unhealthyEvaluation

unhealthyEvaluation: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.unhealthyEvaluation"

type

type: object

name

name: "String" = "String"

Const ApplicationScopedVolume

ApplicationScopedVolume: object

Describes a volume whose lifetime is scoped to the application's lifetime.

creationParameters

Describes parameters for creating application-scoped volumes.

destinationPath

destinationPath: string

The path within the container at which the volume should be mounted. Only valid path characters are allowed.

name

name: string

Name of the volume being referenced.

Optional readOnly

readOnly: undefined | false | true

The flag indicating whether the volume is read only. Default is 'false'.

serializedName

serializedName: string = "ApplicationScopedVolume"

type

type: object

className

className: string = "ApplicationScopedVolume"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationParameters

creationParameters: object

required

required: true = true

serializedName

serializedName: string = "creationParameters"

type

type: object

className

className: string = "ApplicationScopedVolumeCreationParameters"

name

name: "Composite" = "Composite"

Const ApplicationScopedVolumeCreationParameters

ApplicationScopedVolumeCreationParameters: object

Describes parameters for creating application-scoped volumes.

Optional description

description: undefined | string

User readable description of the volume.

kind

kind: "ApplicationScopedVolumeCreationParameters"

Polymorphic Discriminator

serializedName

serializedName: string = "ApplicationScopedVolumeCreationParameters"

type

type: object

className

className: string = "ApplicationScopedVolumeCreationParameters"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ApplicationScopedVolumeCreationParameters"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "kind"

Const ApplicationScopedVolumeCreationParametersServiceFabricVolumeDisk

ApplicationScopedVolumeCreationParametersServiceFabricVolumeDisk: object

Describes parameters for creating application-scoped volumes provided by Service Fabric Volume Disks

Optional description

description: undefined | string

User readable description of the volume.

kind

kind: "ServiceFabricVolumeDisk"

Polymorphic Discriminator

sizeDisk

sizeDisk: SizeTypes

Volume size. Possible values include: 'Small', 'Medium', 'Large'

serializedName

serializedName: string = "ServiceFabricVolumeDisk"

type

type: object

className

className: string = "ApplicationScopedVolumeCreationParametersServiceFabricVolumeDisk"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ApplicationScopedVolumeCreationParameters.type.polymorphicDiscriminator

uberParent

uberParent: string = "ApplicationScopedVolumeCreationParameters"

modelProperties

modelProperties: object

sizeDisk

sizeDisk: object

required

required: true = true

serializedName

serializedName: string = "sizeDisk"

type

type: object

name

name: "String" = "String"

Const ApplicationTypeApplicationsHealthEvaluation

ApplicationTypeApplicationsHealthEvaluation: object

Represents health evaluation for applications of a particular application type. The application type applications evaluation can be returned when cluster health evaluation returns unhealthy aggregated health state, either Error or Warning. It contains health evaluations for each unhealthy application of the included application type that impacted current aggregated health state.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional applicationTypeName

applicationTypeName: undefined | string

The application type name as defined in the application manifest.

Optional description

description: undefined | string

Description of the health evaluation, which represents a summary of the evaluation process.

kind

kind: "ApplicationTypeApplications"

Polymorphic Discriminator

Optional maxPercentUnhealthyApplications

maxPercentUnhealthyApplications: undefined | number

Maximum allowed percentage of unhealthy applications for the application type, specified as an entry in ApplicationTypeHealthPolicyMap.

Optional totalCount

totalCount: undefined | number

Total number of applications of the application type found in the health store.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ApplicationHealthEvaluation of this application type that impacted the aggregated health.

serializedName

serializedName: string = "ApplicationTypeApplications"

type

type: object

className

className: string = "ApplicationTypeApplicationsHealthEvaluation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = HealthEvaluation.type.polymorphicDiscriminator

uberParent

uberParent: string = "HealthEvaluation"

modelProperties

modelProperties: object

applicationTypeName

applicationTypeName: object

serializedName

serializedName: string = "ApplicationTypeName"

type

type: object

name

name: "String" = "String"

maxPercentUnhealthyApplications

maxPercentUnhealthyApplications: object

serializedName

serializedName: string = "MaxPercentUnhealthyApplications"

type

type: object

name

name: "Number" = "Number"

totalCount

totalCount: object

serializedName

serializedName: string = "TotalCount"

type

type: object

name

name: "Number" = "Number"

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

Const ApplicationTypeHealthPolicyMapItem

ApplicationTypeHealthPolicyMapItem: object

Defines an item in ApplicationTypeHealthPolicyMap.

key

key: string

The key of the application type health policy map item. This is the name of the application type.

value

value: number

The value of the application type health policy map item. The max percent unhealthy applications allowed for the application type. Must be between zero and 100.

serializedName

serializedName: string = "ApplicationTypeHealthPolicyMapItem"

type

type: object

className

className: string = "ApplicationTypeHealthPolicyMapItem"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

key

key: object

required

required: true = true

serializedName

serializedName: string = "Key"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "Value"

type

type: object

name

name: "Number" = "Number"

Const ApplicationTypeImageStorePath

ApplicationTypeImageStorePath: object

Path description for the application package in the image store specified during the prior copy operation.

applicationTypeBuildPath

applicationTypeBuildPath: string

The relative image store path to the application package.

serializedName

serializedName: string = "ApplicationTypeImageStorePath"

type

type: object

className

className: string = "ApplicationTypeImageStorePath"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationTypeBuildPath

applicationTypeBuildPath: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeBuildPath"

type

type: object

name

name: "String" = "String"

Const ApplicationTypeInfo

ApplicationTypeInfo: object

Information about an application type.

Optional applicationTypeDefinitionKind

applicationTypeDefinitionKind: ApplicationTypeDefinitionKind

The mechanism used to define a Service Fabric application type. Possible values include: 'Invalid', 'ServiceFabricApplicationPackage', 'Compose'

Optional defaultParameterList

defaultParameterList: ApplicationParameter[]

List of application type parameters that can be overridden when creating or updating the application.

Optional name

name: undefined | string

The application type name as defined in the application manifest.

Optional status

The status of the application type. Possible values include: 'Invalid', 'Provisioning', 'Available', 'Unprovisioning', 'Failed'

Optional statusDetails

statusDetails: undefined | string

Additional detailed information about the status of the application type.

Optional version

version: undefined | string

The version of the application type as defined in the application manifest.

serializedName

serializedName: string = "ApplicationTypeInfo"

type

type: object

className

className: string = "ApplicationTypeInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationTypeDefinitionKind

applicationTypeDefinitionKind: object

serializedName

serializedName: string = "ApplicationTypeDefinitionKind"

type

type: object

name

name: "String" = "String"

defaultParameterList

defaultParameterList: object

serializedName

serializedName: string = "DefaultParameterList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationParameter"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "Status"

type

type: object

name

name: "String" = "String"

statusDetails

statusDetails: object

serializedName

serializedName: string = "StatusDetails"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "Version"

type

type: object

name

name: "String" = "String"

Const ApplicationTypeManifest

ApplicationTypeManifest: object

Contains the manifest describing an application type registered in a Service Fabric cluster.

Optional manifest

manifest: undefined | string

The XML manifest as a string.

serializedName

serializedName: string = "ApplicationTypeManifest"

type

type: object

className

className: string = "ApplicationTypeManifest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

manifest

manifest: object

serializedName

serializedName: string = "Manifest"

type

type: object

name

name: "String" = "String"

Const ApplicationUpgradeCompletedEvent

ApplicationUpgradeCompletedEvent: object

Application Upgrade Completed event.

applicationId

applicationId: string

The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

applicationTypeName

applicationTypeName: string

Application type name.

applicationTypeVersion

applicationTypeVersion: string

Application type version.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ApplicationUpgradeCompleted"

Polymorphic Discriminator

overallUpgradeElapsedTimeInMs

overallUpgradeElapsedTimeInMs: number

Overall upgrade time in milli-seconds.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ApplicationUpgradeCompleted"

type

type: object

className

className: string = "ApplicationUpgradeCompletedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

applicationTypeName

applicationTypeName: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeName"

type

type: object

name

name: "String" = "String"

applicationTypeVersion

applicationTypeVersion: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeVersion"

type

type: object

name

name: "String" = "String"

overallUpgradeElapsedTimeInMs

overallUpgradeElapsedTimeInMs: object

required

required: true = true

serializedName

serializedName: string = "OverallUpgradeElapsedTimeInMs"

type

type: object

name

name: "Number" = "Number"

Const ApplicationUpgradeDescription

ApplicationUpgradeDescription: object

Describes the parameters for an application upgrade. Note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would result in the application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription.

Optional applicationHealthPolicy

applicationHealthPolicy: ApplicationHealthPolicy

Defines a health policy used to evaluate the health of an application or one of its children entities.

Optional forceRestart

forceRestart: undefined | false | true

If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).

Optional monitoringPolicy

monitoringPolicy: MonitoringPolicyDescription

Describes the parameters for monitoring an upgrade in Monitored mode.

name

name: string

The name of the target application, including the 'fabric:' URI scheme.

Optional parameters

parameters: ApplicationParameter[]

List of application parameters with overridden values from their default values specified in the application manifest.

Optional rollingUpgradeMode

rollingUpgradeMode: UpgradeMode

The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Default value: 'UnmonitoredAuto'.

Optional sortOrder

sortOrder: UpgradeSortOrder

Defines the order in which an upgrade proceeds through the cluster. Possible values include: 'Invalid', 'Default', 'Numeric', 'Lexicographical', 'ReverseNumeric', 'ReverseLexicographical'. Default value: 'Default'.

targetApplicationTypeVersion

targetApplicationTypeVersion: string

The target application type version (found in the application manifest) for the application upgrade.

upgradeKind

upgradeKind: UpgradeKind

The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling'. Default value: 'Rolling'.

Optional upgradeReplicaSetCheckTimeoutInSeconds

upgradeReplicaSetCheckTimeoutInSeconds: undefined | number

The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).

serializedName

serializedName: string = "ApplicationUpgradeDescription"

type

type: object

className

className: string = "ApplicationUpgradeDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationHealthPolicy

applicationHealthPolicy: object

serializedName

serializedName: string = "ApplicationHealthPolicy"

type

type: object

className

className: string = "ApplicationHealthPolicy"

name

name: "Composite" = "Composite"

forceRestart

forceRestart: object

serializedName

serializedName: string = "ForceRestart"

type

type: object

name

name: "Boolean" = "Boolean"

monitoringPolicy

monitoringPolicy: object

serializedName

serializedName: string = "MonitoringPolicy"

type

type: object

className

className: string = "MonitoringPolicyDescription"

name

name: "Composite" = "Composite"

name

name: object

required

required: true = true

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

parameters

parameters: object

serializedName

serializedName: string = "Parameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationParameter"

name

name: "Composite" = "Composite"

rollingUpgradeMode

rollingUpgradeMode: object

defaultValue

defaultValue: string = "UnmonitoredAuto"

serializedName

serializedName: string = "RollingUpgradeMode"

type

type: object

name

name: "String" = "String"

sortOrder

sortOrder: object

defaultValue

defaultValue: string = "Default"

serializedName

serializedName: string = "SortOrder"

type

type: object

name

name: "String" = "String"

targetApplicationTypeVersion

targetApplicationTypeVersion: object

required

required: true = true

serializedName

serializedName: string = "TargetApplicationTypeVersion"

type

type: object

name

name: "String" = "String"

upgradeKind

upgradeKind: object

defaultValue

defaultValue: string = "Rolling"

required

required: true = true

serializedName

serializedName: string = "UpgradeKind"

type

type: object

name

name: "String" = "String"

upgradeReplicaSetCheckTimeoutInSeconds

upgradeReplicaSetCheckTimeoutInSeconds: object

serializedName

serializedName: string = "UpgradeReplicaSetCheckTimeoutInSeconds"

type

type: object

name

name: "Number" = "Number"

Const ApplicationUpgradeDomainCompletedEvent

ApplicationUpgradeDomainCompletedEvent: object

Application Upgrade Domain Completed event.

applicationId

applicationId: string

The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

applicationTypeName

applicationTypeName: string

Application type name.

applicationTypeVersion

applicationTypeVersion: string

Target Application type version.

Optional category

category: undefined | string

The category of event.

currentApplicationTypeVersion

currentApplicationTypeVersion: string

Current Application type version.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ApplicationUpgradeDomainCompleted"

Polymorphic Discriminator

timeStamp

timeStamp: Date

The time event was logged.

upgradeDomainElapsedTimeInMs

upgradeDomainElapsedTimeInMs: number

Upgrade time of domain in milli-seconds.

upgradeDomains

upgradeDomains: string

Upgrade domains.

upgradeState

upgradeState: string

State of upgrade.

serializedName

serializedName: string = "ApplicationUpgradeDomainCompleted"

type

type: object

className

className: string = "ApplicationUpgradeDomainCompletedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

applicationTypeName

applicationTypeName: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeName"

type

type: object

name

name: "String" = "String"

applicationTypeVersion

applicationTypeVersion: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeVersion"

type

type: object

name

name: "String" = "String"

currentApplicationTypeVersion

currentApplicationTypeVersion: object

required

required: true = true

serializedName

serializedName: string = "CurrentApplicationTypeVersion"

type

type: object

name

name: "String" = "String"

upgradeDomainElapsedTimeInMs

upgradeDomainElapsedTimeInMs: object

required

required: true = true

serializedName

serializedName: string = "UpgradeDomainElapsedTimeInMs"

type

type: object

name

name: "Number" = "Number"

upgradeDomains

upgradeDomains: object

required

required: true = true

serializedName

serializedName: string = "UpgradeDomains"

type

type: object

name

name: "String" = "String"

upgradeState

upgradeState: object

required

required: true = true

serializedName

serializedName: string = "UpgradeState"

type

type: object

name

name: "String" = "String"

Const ApplicationUpgradeProgressInfo

ApplicationUpgradeProgressInfo: object

Describes the parameters for an application upgrade.

Optional currentUpgradeDomainProgress

currentUpgradeDomainProgress: CurrentUpgradeDomainProgressInfo

Information about the current in-progress upgrade domain.

Optional failureReason

failureReason: FailureReason

The cause of an upgrade failure that resulted in FailureAction being executed. Possible values include: 'None', 'Interrupted', 'HealthCheck', 'UpgradeDomainTimeout', 'OverallUpgradeTimeout'

Optional failureTimestampUtc

failureTimestampUtc: undefined | string

The estimated UTC datetime when the upgrade failed and FailureAction was executed.

Optional name

name: undefined | string

The name of the target application, including the 'fabric:' URI scheme.

Optional nextUpgradeDomain

nextUpgradeDomain: undefined | string

The name of the next upgrade domain to be processed.

Optional rollingUpgradeMode

rollingUpgradeMode: UpgradeMode

The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Default value: 'UnmonitoredAuto'.

Optional startTimestampUtc

startTimestampUtc: undefined | string

The estimated UTC datetime when the upgrade started.

Optional targetApplicationTypeVersion

targetApplicationTypeVersion: undefined | string

The target application type version (found in the application manifest) for the application upgrade.

Optional typeName

typeName: undefined | string

The application type name as defined in the application manifest.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

List of health evaluations that resulted in the current aggregated health state.

Optional upgradeDescription

upgradeDescription: ApplicationUpgradeDescription

Describes the parameters for an application upgrade. Note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would result in the application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription.

Optional upgradeDomainDurationInMilliseconds

upgradeDomainDurationInMilliseconds: undefined | string

The estimated total amount of time spent processing the current upgrade domain.

Optional upgradeDomainProgressAtFailure

upgradeDomainProgressAtFailure: FailureUpgradeDomainProgressInfo

Information about the upgrade domain progress at the time of upgrade failure.

Optional upgradeDomains

upgradeDomains: UpgradeDomainInfo[]

List of upgrade domains and their statuses.

Optional upgradeDurationInMilliseconds

upgradeDurationInMilliseconds: undefined | string

The estimated total amount of time spent processing the overall upgrade.

Optional upgradeState

upgradeState: UpgradeState

The state of the upgrade domain. Possible values include: 'Invalid', 'RollingBackInProgress', 'RollingBackCompleted', 'RollingForwardPending', 'RollingForwardInProgress', 'RollingForwardCompleted', 'Failed'

Optional upgradeStatusDetails

upgradeStatusDetails: undefined | string

Additional detailed information about the status of the pending upgrade.

serializedName

serializedName: string = "ApplicationUpgradeProgressInfo"

type

type: object

className

className: string = "ApplicationUpgradeProgressInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

currentUpgradeDomainProgress

currentUpgradeDomainProgress: object

serializedName

serializedName: string = "CurrentUpgradeDomainProgress"

type

type: object

className

className: string = "CurrentUpgradeDomainProgressInfo"

name

name: "Composite" = "Composite"

failureReason

failureReason: object

serializedName

serializedName: string = "FailureReason"

type

type: object

name

name: "String" = "String"

failureTimestampUtc

failureTimestampUtc: object

serializedName

serializedName: string = "FailureTimestampUtc"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

nextUpgradeDomain

nextUpgradeDomain: object

serializedName

serializedName: string = "NextUpgradeDomain"

type

type: object

name

name: "String" = "String"

rollingUpgradeMode

rollingUpgradeMode: object

defaultValue

defaultValue: string = "UnmonitoredAuto"

serializedName

serializedName: string = "RollingUpgradeMode"

type

type: object

name

name: "String" = "String"

startTimestampUtc

startTimestampUtc: object

serializedName

serializedName: string = "StartTimestampUtc"

type

type: object

name

name: "String" = "String"

targetApplicationTypeVersion

targetApplicationTypeVersion: object

serializedName

serializedName: string = "TargetApplicationTypeVersion"

type

type: object

name

name: "String" = "String"

typeName

typeName: object

serializedName

serializedName: string = "TypeName"

type

type: object

name

name: "String" = "String"

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

upgradeDescription

upgradeDescription: object

serializedName

serializedName: string = "UpgradeDescription"

type

type: object

className

className: string = "ApplicationUpgradeDescription"

name

name: "Composite" = "Composite"

upgradeDomainDurationInMilliseconds

upgradeDomainDurationInMilliseconds: object

serializedName

serializedName: string = "UpgradeDomainDurationInMilliseconds"

type

type: object

name

name: "String" = "String"

upgradeDomainProgressAtFailure

upgradeDomainProgressAtFailure: object

serializedName

serializedName: string = "UpgradeDomainProgressAtFailure"

type

type: object

className

className: string = "FailureUpgradeDomainProgressInfo"

name

name: "Composite" = "Composite"

upgradeDomains

upgradeDomains: object

serializedName

serializedName: string = "UpgradeDomains"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "UpgradeDomainInfo"

name

name: "Composite" = "Composite"

upgradeDurationInMilliseconds

upgradeDurationInMilliseconds: object

serializedName

serializedName: string = "UpgradeDurationInMilliseconds"

type

type: object

name

name: "String" = "String"

upgradeState

upgradeState: object

serializedName

serializedName: string = "UpgradeState"

type

type: object

name

name: "String" = "String"

upgradeStatusDetails

upgradeStatusDetails: object

serializedName

serializedName: string = "UpgradeStatusDetails"

type

type: object

name

name: "String" = "String"

Const ApplicationUpgradeRollbackCompletedEvent

ApplicationUpgradeRollbackCompletedEvent: object

Application Upgrade Rollback Completed event.

applicationId

applicationId: string

The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

applicationTypeName

applicationTypeName: string

Application type name.

applicationTypeVersion

applicationTypeVersion: string

Application type version.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

failureReason

failureReason: string

Describes reason of failure.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ApplicationUpgradeRollbackCompleted"

Polymorphic Discriminator

overallUpgradeElapsedTimeInMs

overallUpgradeElapsedTimeInMs: number

Overall upgrade time in milli-seconds.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ApplicationUpgradeRollbackCompleted"

type

type: object

className

className: string = "ApplicationUpgradeRollbackCompletedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

applicationTypeName

applicationTypeName: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeName"

type

type: object

name

name: "String" = "String"

applicationTypeVersion

applicationTypeVersion: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeVersion"

type

type: object

name

name: "String" = "String"

failureReason

failureReason: object

required

required: true = true

serializedName

serializedName: string = "FailureReason"

type

type: object

name

name: "String" = "String"

overallUpgradeElapsedTimeInMs

overallUpgradeElapsedTimeInMs: object

required

required: true = true

serializedName

serializedName: string = "OverallUpgradeElapsedTimeInMs"

type

type: object

name

name: "Number" = "Number"

Const ApplicationUpgradeRollbackStartedEvent

ApplicationUpgradeRollbackStartedEvent: object

Application Upgrade Rollback Started event.

applicationId

applicationId: string

The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

applicationTypeName

applicationTypeName: string

Application type name.

applicationTypeVersion

applicationTypeVersion: string

Target Application type version.

Optional category

category: undefined | string

The category of event.

currentApplicationTypeVersion

currentApplicationTypeVersion: string

Current Application type version.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

failureReason

failureReason: string

Describes reason of failure.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ApplicationUpgradeRollbackStarted"

Polymorphic Discriminator

overallUpgradeElapsedTimeInMs

overallUpgradeElapsedTimeInMs: number

Overall upgrade time in milli-seconds.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ApplicationUpgradeRollbackStarted"

type

type: object

className

className: string = "ApplicationUpgradeRollbackStartedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

applicationTypeName

applicationTypeName: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeName"

type

type: object

name

name: "String" = "String"

applicationTypeVersion

applicationTypeVersion: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeVersion"

type

type: object

name

name: "String" = "String"

currentApplicationTypeVersion

currentApplicationTypeVersion: object

required

required: true = true

serializedName

serializedName: string = "CurrentApplicationTypeVersion"

type

type: object

name

name: "String" = "String"

failureReason

failureReason: object

required

required: true = true

serializedName

serializedName: string = "FailureReason"

type

type: object

name

name: "String" = "String"

overallUpgradeElapsedTimeInMs

overallUpgradeElapsedTimeInMs: object

required

required: true = true

serializedName

serializedName: string = "OverallUpgradeElapsedTimeInMs"

type

type: object

name

name: "Number" = "Number"

Const ApplicationUpgradeStartedEvent

ApplicationUpgradeStartedEvent: object

Application Upgrade Started event.

applicationId

applicationId: string

The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

applicationTypeName

applicationTypeName: string

Application type name.

applicationTypeVersion

applicationTypeVersion: string

Target Application type version.

Optional category

category: undefined | string

The category of event.

currentApplicationTypeVersion

currentApplicationTypeVersion: string

Current Application type version.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

failureAction

failureAction: string

Action if failed.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ApplicationUpgradeStarted"

Polymorphic Discriminator

rollingUpgradeMode

rollingUpgradeMode: string

Mode of upgrade.

timeStamp

timeStamp: Date

The time event was logged.

upgradeType

upgradeType: string

Type of upgrade.

serializedName

serializedName: string = "ApplicationUpgradeStarted"

type

type: object

className

className: string = "ApplicationUpgradeStartedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

applicationTypeName

applicationTypeName: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeName"

type

type: object

name

name: "String" = "String"

applicationTypeVersion

applicationTypeVersion: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeVersion"

type

type: object

name

name: "String" = "String"

currentApplicationTypeVersion

currentApplicationTypeVersion: object

required

required: true = true

serializedName

serializedName: string = "CurrentApplicationTypeVersion"

type

type: object

name

name: "String" = "String"

failureAction

failureAction: object

required

required: true = true

serializedName

serializedName: string = "FailureAction"

type

type: object

name

name: "String" = "String"

rollingUpgradeMode

rollingUpgradeMode: object

required

required: true = true

serializedName

serializedName: string = "RollingUpgradeMode"

type

type: object

name

name: "String" = "String"

upgradeType

upgradeType: object

required

required: true = true

serializedName

serializedName: string = "UpgradeType"

type

type: object

name

name: "String" = "String"

Const ApplicationUpgradeUpdateDescription

ApplicationUpgradeUpdateDescription: object

Describes the parameters for updating an ongoing application upgrade.

Optional applicationHealthPolicy

applicationHealthPolicy: ApplicationHealthPolicy

Defines a health policy used to evaluate the health of an application or one of its children entities.

name

name: string

The name of the application, including the 'fabric:' URI scheme.

Optional updateDescription

Describes the parameters for updating a rolling upgrade of application or cluster.

upgradeKind

upgradeKind: UpgradeKind

The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling'. Default value: 'Rolling'.

serializedName

serializedName: string = "ApplicationUpgradeUpdateDescription"

type

type: object

className

className: string = "ApplicationUpgradeUpdateDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationHealthPolicy

applicationHealthPolicy: object

serializedName

serializedName: string = "ApplicationHealthPolicy"

type

type: object

className

className: string = "ApplicationHealthPolicy"

name

name: "Composite" = "Composite"

name

name: object

required

required: true = true

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

updateDescription

updateDescription: object

serializedName

serializedName: string = "UpdateDescription"

type

type: object

className

className: string = "RollingUpgradeUpdateDescription"

name

name: "Composite" = "Composite"

upgradeKind

upgradeKind: object

defaultValue

defaultValue: string = "Rolling"

required

required: true = true

serializedName

serializedName: string = "UpgradeKind"

type

type: object

name

name: "String" = "String"

Const ApplicationsHealthEvaluation

ApplicationsHealthEvaluation: object

Represents health evaluation for applications, containing health evaluations for each unhealthy application that impacted current aggregated health state.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional description

description: undefined | string

Description of the health evaluation, which represents a summary of the evaluation process.

kind

kind: "Applications"

Polymorphic Discriminator

Optional maxPercentUnhealthyApplications

maxPercentUnhealthyApplications: undefined | number

Maximum allowed percentage of unhealthy applications from the ClusterHealthPolicy.

Optional totalCount

totalCount: undefined | number

Total number of applications from the health store.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ApplicationHealthEvaluation that impacted the aggregated health.

serializedName

serializedName: string = "Applications"

type

type: object

className

className: string = "ApplicationsHealthEvaluation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = HealthEvaluation.type.polymorphicDiscriminator

uberParent

uberParent: string = "HealthEvaluation"

modelProperties

modelProperties: object

maxPercentUnhealthyApplications

maxPercentUnhealthyApplications: object

serializedName

serializedName: string = "MaxPercentUnhealthyApplications"

type

type: object

name

name: "Number" = "Number"

totalCount

totalCount: object

serializedName

serializedName: string = "TotalCount"

type

type: object

name

name: "Number" = "Number"

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

Const AutoScalingMechanism

AutoScalingMechanism: object

Describes the mechanism for performing auto scaling operation. Derived classes will describe the actual mechanism.

kind

kind: "AutoScalingMechanism"

Polymorphic Discriminator

serializedName

serializedName: string = "AutoScalingMechanism"

type

type: object

className

className: string = "AutoScalingMechanism"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "AutoScalingMechanism"

modelProperties

modelProperties: object

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "kind"

Const AutoScalingMetric

AutoScalingMetric: object

Describes the metric that is used for triggering auto scaling operation. Derived classes will describe resources or metrics.

kind

kind: "AutoScalingMetric"

Polymorphic Discriminator

serializedName

serializedName: string = "AutoScalingMetric"

type

type: object

className

className: string = "AutoScalingMetric"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "AutoScalingMetric"

modelProperties

modelProperties: object

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "kind"

Const AutoScalingPolicy

AutoScalingPolicy: object

Describes the auto scaling policy

mechanism

The mechanism that is used to scale when auto scaling operation is invoked.

name

name: string

The name of the auto scaling policy.

trigger

Determines when auto scaling operation will be invoked.

serializedName

serializedName: string = "AutoScalingPolicy"

type

type: object

className

className: string = "AutoScalingPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

mechanism

mechanism: object

required

required: true = true

serializedName

serializedName: string = "mechanism"

type

type: object

className

className: string = "AutoScalingMechanism"

name

name: "Composite" = "Composite"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

trigger

trigger: object

required

required: true = true

serializedName

serializedName: string = "trigger"

type

type: object

className

className: string = "AutoScalingTrigger"

name

name: "Composite" = "Composite"

Const AutoScalingResourceMetric

AutoScalingResourceMetric: object

Describes the resource that is used for triggering auto scaling.

kind

kind: "Resource"

Polymorphic Discriminator

name

Name of the resource. Possible values include: 'cpu', 'memoryInGB'

serializedName

serializedName: string = "Resource"

type

type: object

className

className: string = "AutoScalingResourceMetric"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = AutoScalingMetric.type.polymorphicDiscriminator

uberParent

uberParent: string = "AutoScalingMetric"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const AutoScalingTrigger

AutoScalingTrigger: object

Describes the trigger for performing auto scaling operation.

kind

kind: "AutoScalingTrigger"

Polymorphic Discriminator

serializedName

serializedName: string = "AutoScalingTrigger"

type

type: object

className

className: string = "AutoScalingTrigger"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "AutoScalingTrigger"

modelProperties

modelProperties: object

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "kind"

Const AverageLoadScalingTrigger

AverageLoadScalingTrigger: object

Describes the average load trigger used for auto scaling.

kind

kind: "AverageLoad"

Polymorphic Discriminator

lowerLoadThreshold

lowerLoadThreshold: number

Lower load threshold (if average load is below this threshold, service will scale down).

metric

Description of the metric that is used for scaling.

scaleIntervalInSeconds

scaleIntervalInSeconds: number

Scale interval that indicates how often will this trigger be checked.

upperLoadThreshold

upperLoadThreshold: number

Upper load threshold (if average load is above this threshold, service will scale up).

serializedName

serializedName: string = "AverageLoad"

type

type: object

className

className: string = "AverageLoadScalingTrigger"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = AutoScalingTrigger.type.polymorphicDiscriminator

uberParent

uberParent: string = "AutoScalingTrigger"

modelProperties

modelProperties: object

lowerLoadThreshold

lowerLoadThreshold: object

required

required: true = true

serializedName

serializedName: string = "lowerLoadThreshold"

type

type: object

name

name: "Number" = "Number"

metric

metric: object

required

required: true = true

serializedName

serializedName: string = "metric"

type

type: object

className

className: string = "AutoScalingMetric"

name

name: "Composite" = "Composite"

scaleIntervalInSeconds

scaleIntervalInSeconds: object

required

required: true = true

serializedName

serializedName: string = "scaleIntervalInSeconds"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 60

type

type: object

name

name: "Number" = "Number"

upperLoadThreshold

upperLoadThreshold: object

required

required: true = true

serializedName

serializedName: string = "upperLoadThreshold"

type

type: object

name

name: "Number" = "Number"

Const AveragePartitionLoadScalingTrigger

AveragePartitionLoadScalingTrigger: object

Represents a scaling trigger related to an average load of a metric/resource of a partition.

kind

kind: "AveragePartitionLoad"

Polymorphic Discriminator

lowerLoadThreshold

lowerLoadThreshold: string

The lower limit of the load below which a scale in operation should be performed.

metricName

metricName: string

The name of the metric for which usage should be tracked.

scaleIntervalInSeconds

scaleIntervalInSeconds: number

The period in seconds on which a decision is made whether to scale or not.

upperLoadThreshold

upperLoadThreshold: string

The upper limit of the load beyond which a scale out operation should be performed.

serializedName

serializedName: string = "AveragePartitionLoad"

type

type: object

className

className: string = "AveragePartitionLoadScalingTrigger"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ScalingTriggerDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "ScalingTriggerDescription"

modelProperties

modelProperties: object

lowerLoadThreshold

lowerLoadThreshold: object

required

required: true = true

serializedName

serializedName: string = "LowerLoadThreshold"

type

type: object

name

name: "String" = "String"

metricName

metricName: object

required

required: true = true

serializedName

serializedName: string = "MetricName"

type

type: object

name

name: "String" = "String"

scaleIntervalInSeconds

scaleIntervalInSeconds: object

required

required: true = true

serializedName

serializedName: string = "ScaleIntervalInSeconds"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 4294967295

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

upperLoadThreshold

upperLoadThreshold: object

required

required: true = true

serializedName

serializedName: string = "UpperLoadThreshold"

type

type: object

name

name: "String" = "String"

Const AverageServiceLoadScalingTrigger

AverageServiceLoadScalingTrigger: object

Represents a scaling policy related to an average load of a metric/resource of a service.

kind

kind: "AverageServiceLoad"

Polymorphic Discriminator

lowerLoadThreshold

lowerLoadThreshold: string

The lower limit of the load below which a scale in operation should be performed.

metricName

metricName: string

The name of the metric for which usage should be tracked.

scaleIntervalInSeconds

scaleIntervalInSeconds: number

The period in seconds on which a decision is made whether to scale or not.

upperLoadThreshold

upperLoadThreshold: string

The upper limit of the load beyond which a scale out operation should be performed.

serializedName

serializedName: string = "AverageServiceLoad"

type

type: object

className

className: string = "AverageServiceLoadScalingTrigger"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ScalingTriggerDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "ScalingTriggerDescription"

modelProperties

modelProperties: object

lowerLoadThreshold

lowerLoadThreshold: object

required

required: true = true

serializedName

serializedName: string = "LowerLoadThreshold"

type

type: object

name

name: "String" = "String"

metricName

metricName: object

required

required: true = true

serializedName

serializedName: string = "MetricName"

type

type: object

name

name: "String" = "String"

scaleIntervalInSeconds

scaleIntervalInSeconds: object

required

required: true = true

serializedName

serializedName: string = "ScaleIntervalInSeconds"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 4294967295

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

upperLoadThreshold

upperLoadThreshold: object

required

required: true = true

serializedName

serializedName: string = "UpperLoadThreshold"

type

type: object

name

name: "String" = "String"

Const AzureBlobBackupStorageDescription

AzureBlobBackupStorageDescription: object

Describes the parameters for Azure blob store used for storing and enumerating backups.

connectionString

connectionString: string

The connection string to connect to the Azure blob store.

containerName

containerName: string

The name of the container in the blob store to store and enumerate backups from.

Optional friendlyName

friendlyName: undefined | string

Friendly name for this backup storage.

storageKind

storageKind: "AzureBlobStore"

Polymorphic Discriminator

serializedName

serializedName: string = "AzureBlobStore"

type

type: object

className

className: string = "AzureBlobBackupStorageDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = BackupStorageDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "BackupStorageDescription"

modelProperties

modelProperties: object

connectionString

connectionString: object

required

required: true = true

serializedName

serializedName: string = "ConnectionString"

type

type: object

name

name: "String" = "String"

containerName

containerName: object

required

required: true = true

serializedName

serializedName: string = "ContainerName"

type

type: object

name

name: "String" = "String"

Const AzureInternalMonitoringPipelineSinkDescription

AzureInternalMonitoringPipelineSinkDescription: object

Diagnostics settings for Geneva.

Optional accountName

accountName: undefined | string

Azure Internal monitoring pipeline account.

Optional autoKeyConfigUrl

autoKeyConfigUrl: undefined | string

Azure Internal monitoring pipeline autokey associated with the certificate.

Optional description

description: undefined | string

A description of the sink.

Optional fluentdConfigUrl

fluentdConfigUrl: undefined | string

Azure Internal monitoring agent fluentd configuration.

kind

kind: "AzureInternalMonitoringPipeline"

Polymorphic Discriminator

Optional maConfigUrl

maConfigUrl: undefined | string

Azure Internal monitoring agent configuration.

Optional name

name: undefined | string

Name of the sink. This value is referenced by DiagnosticsReferenceDescription

Optional namespace

namespace: undefined | string

Azure Internal monitoring pipeline account namespace.

serializedName

serializedName: string = "AzureInternalMonitoringPipeline"

type

type: object

className

className: string = "AzureInternalMonitoringPipelineSinkDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = DiagnosticsSinkProperties.type.polymorphicDiscriminator

uberParent

uberParent: string = "DiagnosticsSinkProperties"

modelProperties

modelProperties: object

accountName

accountName: object

serializedName

serializedName: string = "accountName"

type

type: object

name

name: "String" = "String"

autoKeyConfigUrl

autoKeyConfigUrl: object

serializedName

serializedName: string = "autoKeyConfigUrl"

type

type: object

name

name: "String" = "String"

fluentdConfigUrl

fluentdConfigUrl: object

serializedName

serializedName: string = "fluentdConfigUrl"

type

type: object

name

name: "String" = "String"

maConfigUrl

maConfigUrl: object

serializedName

serializedName: string = "maConfigUrl"

type

type: object

name

name: "String" = "String"

namespace

namespace: object

serializedName

serializedName: string = "namespace"

type

type: object

name

name: "String" = "String"

Const BackupConfigurationInfo

BackupConfigurationInfo: object

Describes the backup configuration information.

kind

kind: "BackupConfigurationInfo"

Polymorphic Discriminator

Optional policyInheritedFrom

policyInheritedFrom: BackupPolicyScope

Specifies the scope at which the backup policy is applied. Possible values include: 'Invalid', 'Partition', 'Service', 'Application'

Optional policyName

policyName: undefined | string

The name of the backup policy which is applicable to this Service Fabric application or service or partition.

Optional suspensionInfo

suspensionInfo: BackupSuspensionInfo

Describes the backup suspension details.

serializedName

serializedName: string = "BackupConfigurationInfo"

type

type: object

className

className: string = "BackupConfigurationInfo"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "BackupConfigurationInfo"

modelProperties

modelProperties: object

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "Kind"

type

type: object

name

name: "String" = "String"

policyInheritedFrom

policyInheritedFrom: object

serializedName

serializedName: string = "PolicyInheritedFrom"

type

type: object

name

name: "String" = "String"

policyName

policyName: object

serializedName

serializedName: string = "PolicyName"

type

type: object

name

name: "String" = "String"

suspensionInfo

suspensionInfo: object

serializedName

serializedName: string = "SuspensionInfo"

type

type: object

className

className: string = "BackupSuspensionInfo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "Kind"

Const BackupEntity

BackupEntity: object

Describes the Service Fabric entity that is configured for backup.

entityKind

entityKind: "BackupEntity"

Polymorphic Discriminator

serializedName

serializedName: string = "BackupEntity"

type

type: object

className

className: string = "BackupEntity"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "BackupEntity"

modelProperties

modelProperties: object

entityKind

entityKind: object

required

required: true = true

serializedName

serializedName: string = "EntityKind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "entityKind"

serializedName

serializedName: string = "EntityKind"

Const BackupInfo

BackupInfo: object

Represents a backup point which can be used to trigger a restore.

Optional applicationName

applicationName: undefined | string

Name of the Service Fabric application this partition backup belongs to.

Optional backupChainId

backupChainId: undefined | string

Unique backup chain ID. All backups part of the same chain has the same backup chain id. A backup chain is comprised of 1 full backup and multiple incremental backups.

Optional backupId

backupId: undefined | string

Unique backup ID .

Optional backupLocation

backupLocation: undefined | string

Location of the backup, relative to the backup store.

Optional backupType

backupType: BackupType

Describes the type of backup, whether its full or incremental. Possible values include: 'Invalid', 'Full', 'Incremental'

Optional creationTimeUtc

creationTimeUtc: Date

The date time when this backup was taken.

Optional epochOfLastBackupRecord

epochOfLastBackupRecord: Epoch

Epoch of the last record in this backup.

Optional failureError

failureError: FabricErrorError

Denotes the failure encountered in getting backup point information.

Optional lsnOfLastBackupRecord

lsnOfLastBackupRecord: undefined | string

LSN of the last record in this backup.

Optional partitionInformation

partitionInformation: PartitionInformationUnion

Information about the partition to which this backup belongs to

Optional serviceManifestVersion

serviceManifestVersion: undefined | string

Manifest Version of the service this partition backup belongs to.

Optional serviceName

serviceName: undefined | string

Name of the Service Fabric service this partition backup belongs to.

serializedName

serializedName: string = "BackupInfo"

type

type: object

className

className: string = "BackupInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationName

applicationName: object

serializedName

serializedName: string = "ApplicationName"

type

type: object

name

name: "String" = "String"

backupChainId

backupChainId: object

serializedName

serializedName: string = "BackupChainId"

type

type: object

name

name: "Uuid" = "Uuid"

backupId

backupId: object

serializedName

serializedName: string = "BackupId"

type

type: object

name

name: "Uuid" = "Uuid"

backupLocation

backupLocation: object

serializedName

serializedName: string = "BackupLocation"

type

type: object

name

name: "String" = "String"

backupType

backupType: object

serializedName

serializedName: string = "BackupType"

type

type: object

name

name: "String" = "String"

creationTimeUtc

creationTimeUtc: object

serializedName

serializedName: string = "CreationTimeUtc"

type

type: object

name

name: "DateTime" = "DateTime"

epochOfLastBackupRecord

epochOfLastBackupRecord: object

serializedName

serializedName: string = "EpochOfLastBackupRecord"

type

type: object

className

className: string = "Epoch"

name

name: "Composite" = "Composite"

failureError

failureError: object

serializedName

serializedName: string = "FailureError"

type

type: object

className

className: string = "FabricErrorError"

name

name: "Composite" = "Composite"

lsnOfLastBackupRecord

lsnOfLastBackupRecord: object

serializedName

serializedName: string = "LsnOfLastBackupRecord"

type

type: object

name

name: "String" = "String"

partitionInformation

partitionInformation: object

serializedName

serializedName: string = "PartitionInformation"

type

type: object

className

className: string = "PartitionInformation"

name

name: "Composite" = "Composite"

serviceManifestVersion

serviceManifestVersion: object

serializedName

serializedName: string = "ServiceManifestVersion"

type

type: object

name

name: "String" = "String"

serviceName

serviceName: object

serializedName

serializedName: string = "ServiceName"

type

type: object

name

name: "String" = "String"

Const BackupPartitionDescription

BackupPartitionDescription: object

Describes the parameters for triggering partition's backup.

Optional backupStorage

Specifies the details of the backup storage where to save the backup.

serializedName

serializedName: string = "BackupPartitionDescription"

type

type: object

className

className: string = "BackupPartitionDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupStorage

backupStorage: object

serializedName

serializedName: string = "BackupStorage"

type

type: object

className

className: string = "BackupStorageDescription"

name

name: "Composite" = "Composite"

Const BackupPolicyDescription

BackupPolicyDescription: object

Describes a backup policy for configuring periodic backup.

autoRestoreOnDataLoss

autoRestoreOnDataLoss: boolean

Specifies whether to trigger restore automatically using the latest available backup in case the partition experiences a data loss event.

maxIncrementalBackups

maxIncrementalBackups: number

Defines the maximum number of incremental backups to be taken between two full backups. This is just the upper limit. A full backup may be taken before specified number of incremental backups are completed in one of the following conditions

  • The replica has never taken a full backup since it has become primary,
  • Some of the log records since the last backup has been truncated, or
  • Replica passed the MaxAccumulatedBackupLogSizeInMB limit.

name

name: string

The unique name identifying this backup policy.

Optional retentionPolicy

Describes the policy to retain backups in storage.

schedule

Describes the backup schedule parameters.

storage

Describes the details of backup storage where to store the periodic backups.

serializedName

serializedName: string = "BackupPolicyDescription"

type

type: object

className

className: string = "BackupPolicyDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

autoRestoreOnDataLoss

autoRestoreOnDataLoss: object

required

required: true = true

serializedName

serializedName: string = "AutoRestoreOnDataLoss"

type

type: object

name

name: "Boolean" = "Boolean"

maxIncrementalBackups

maxIncrementalBackups: object

required

required: true = true

serializedName

serializedName: string = "MaxIncrementalBackups"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 255

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

name

name: object

required

required: true = true

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

retentionPolicy

retentionPolicy: object

serializedName

serializedName: string = "RetentionPolicy"

type

type: object

className

className: string = "RetentionPolicyDescription"

name

name: "Composite" = "Composite"

schedule

schedule: object

required

required: true = true

serializedName

serializedName: string = "Schedule"

type

type: object

className

className: string = "BackupScheduleDescription"

name

name: "Composite" = "Composite"

storage

storage: object

required

required: true = true

serializedName

serializedName: string = "Storage"

type

type: object

className

className: string = "BackupStorageDescription"

name

name: "Composite" = "Composite"

Const BackupProgressInfo

BackupProgressInfo: object

Describes the progress of a partition's backup.

Optional backupId

backupId: undefined | string

Unique ID of the newly created backup.

Optional backupLocation

backupLocation: undefined | string

Location, relative to the backup store, of the newly created backup.

Optional backupState

backupState: BackupState

Represents the current state of the partition backup operation. Possible values include: 'Invalid', 'Accepted', 'BackupInProgress', 'Success', 'Failure', 'Timeout'

Optional epochOfLastBackupRecord

epochOfLastBackupRecord: Epoch

Specifies the epoch of the last record included in backup.

Optional failureError

failureError: FabricErrorError

Denotes the failure encountered in performing backup operation.

Optional lsnOfLastBackupRecord

lsnOfLastBackupRecord: undefined | string

The LSN of last record included in backup.

Optional timeStampUtc

timeStampUtc: Date

TimeStamp in UTC when operation succeeded or failed.

serializedName

serializedName: string = "BackupProgressInfo"

type

type: object

className

className: string = "BackupProgressInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupId

backupId: object

serializedName

serializedName: string = "BackupId"

type

type: object

name

name: "Uuid" = "Uuid"

backupLocation

backupLocation: object

serializedName

serializedName: string = "BackupLocation"

type

type: object

name

name: "String" = "String"

backupState

backupState: object

serializedName

serializedName: string = "BackupState"

type

type: object

name

name: "String" = "String"

epochOfLastBackupRecord

epochOfLastBackupRecord: object

serializedName

serializedName: string = "EpochOfLastBackupRecord"

type

type: object

className

className: string = "Epoch"

name

name: "Composite" = "Composite"

failureError

failureError: object

serializedName

serializedName: string = "FailureError"

type

type: object

className

className: string = "FabricErrorError"

name

name: "Composite" = "Composite"

lsnOfLastBackupRecord

lsnOfLastBackupRecord: object

serializedName

serializedName: string = "LsnOfLastBackupRecord"

type

type: object

name

name: "String" = "String"

timeStampUtc

timeStampUtc: object

serializedName

serializedName: string = "TimeStampUtc"

type

type: object

name

name: "DateTime" = "DateTime"

Const BackupScheduleDescription

BackupScheduleDescription: object

Describes the backup schedule parameters.

scheduleKind

scheduleKind: "BackupScheduleDescription"

Polymorphic Discriminator

serializedName

serializedName: string = "BackupScheduleDescription"

type

type: object

className

className: string = "BackupScheduleDescription"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "BackupScheduleDescription"

modelProperties

modelProperties: object

scheduleKind

scheduleKind: object

required

required: true = true

serializedName

serializedName: string = "ScheduleKind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "scheduleKind"

serializedName

serializedName: string = "ScheduleKind"

Const BackupStorageDescription

BackupStorageDescription: object

Describes the parameters for the backup storage.

Optional friendlyName

friendlyName: undefined | string

Friendly name for this backup storage.

storageKind

storageKind: "BackupStorageDescription"

Polymorphic Discriminator

serializedName

serializedName: string = "BackupStorageDescription"

type

type: object

className

className: string = "BackupStorageDescription"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "BackupStorageDescription"

modelProperties

modelProperties: object

friendlyName

friendlyName: object

serializedName

serializedName: string = "FriendlyName"

type

type: object

name

name: "String" = "String"

storageKind

storageKind: object

required

required: true = true

serializedName

serializedName: string = "StorageKind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "storageKind"

serializedName

serializedName: string = "StorageKind"

Const BackupSuspensionInfo

BackupSuspensionInfo: object

Describes the backup suspension details.

Optional isSuspended

isSuspended: undefined | false | true

Indicates whether periodic backup is suspended at this level or not.

Optional suspensionInheritedFrom

suspensionInheritedFrom: BackupSuspensionScope

Specifies the scope at which the backup suspension was applied. Possible values include: 'Invalid', 'Partition', 'Service', 'Application'

serializedName

serializedName: string = "BackupSuspensionInfo"

type

type: object

className

className: string = "BackupSuspensionInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

isSuspended

isSuspended: object

serializedName

serializedName: string = "IsSuspended"

type

type: object

name

name: "Boolean" = "Boolean"

suspensionInheritedFrom

suspensionInheritedFrom: object

serializedName

serializedName: string = "SuspensionInheritedFrom"

type

type: object

name

name: "String" = "String"

Const BasicRetentionPolicyDescription

BasicRetentionPolicyDescription: object

Describes basic retention policy.

Optional minimumNumberOfBackups

minimumNumberOfBackups: undefined | number

It is the minimum number of backups to be retained at any point of time. If specified with a non zero value, backups will not be deleted even if the backups have gone past retention duration and have number of backups less than or equal to it.

retentionDuration

retentionDuration: string

It is the minimum duration for which a backup created, will remain stored in the storage and might get deleted after that span of time. It should be specified in ISO8601 format.

retentionPolicyType

retentionPolicyType: "Basic"

Polymorphic Discriminator

serializedName

serializedName: string = "Basic"

type

type: object

className

className: string = "BasicRetentionPolicyDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RetentionPolicyDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "RetentionPolicyDescription"

modelProperties

modelProperties: object

minimumNumberOfBackups

minimumNumberOfBackups: object

serializedName

serializedName: string = "MinimumNumberOfBackups"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

retentionDuration

retentionDuration: object

required

required: true = true

serializedName

serializedName: string = "RetentionDuration"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const BinaryPropertyValue

BinaryPropertyValue: object

Describes a Service Fabric property value of type Binary.

data

data: number[]

Array of bytes to be sent as an integer array. Each element of array is a number between 0 and 255.

kind

kind: "Binary"

Polymorphic Discriminator

serializedName

serializedName: string = "Binary"

type

type: object

className

className: string = "BinaryPropertyValue"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PropertyValue.type.polymorphicDiscriminator

uberParent

uberParent: string = "PropertyValue"

modelProperties

modelProperties: object

data

data: object

required

required: true = true

serializedName

serializedName: string = "Data"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Number" = "Number"

Const Chaos

Chaos: object

Contains a description of Chaos.

Optional chaosParameters

chaosParameters: ChaosParameters

If Chaos is running, these are the parameters Chaos is running with.

Optional scheduleStatus

scheduleStatus: ChaosScheduleStatus

Current status of the schedule. Possible values include: 'Invalid', 'Stopped', 'Active', 'Expired', 'Pending'

Optional status

status: ChaosStatus

Current status of the Chaos run. Possible values include: 'Invalid', 'Running', 'Stopped'

serializedName

serializedName: string = "Chaos"

type

type: object

className

className: string = "Chaos"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

chaosParameters

chaosParameters: object

serializedName

serializedName: string = "ChaosParameters"

type

type: object

className

className: string = "ChaosParameters"

name

name: "Composite" = "Composite"

scheduleStatus

scheduleStatus: object

serializedName

serializedName: string = "ScheduleStatus"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "Status"

type

type: object

name

name: "String" = "String"

Const ChaosCodePackageRestartScheduledEvent

ChaosCodePackageRestartScheduledEvent: object

Chaos Restart Code Package Fault Scheduled event.

applicationId

applicationId: string

The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

Optional category

category: undefined | string

The category of event.

codePackageName

codePackageName: string

Code package name.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

faultGroupId

faultGroupId: string

Id of fault group.

faultId

faultId: string

Id of fault.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ChaosCodePackageRestartScheduled"

Polymorphic Discriminator

nodeName

nodeName: string

The name of a Service Fabric node.

serviceManifestName

serviceManifestName: string

Service manifest name.

servicePackageActivationId

servicePackageActivationId: string

Id of Service package activation.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ChaosCodePackageRestartScheduled"

type

type: object

className

className: string = "ChaosCodePackageRestartScheduledEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

codePackageName

codePackageName: object

required

required: true = true

serializedName

serializedName: string = "CodePackageName"

type

type: object

name

name: "String" = "String"

faultGroupId

faultGroupId: object

required

required: true = true

serializedName

serializedName: string = "FaultGroupId"

type

type: object

name

name: "Uuid" = "Uuid"

faultId

faultId: object

required

required: true = true

serializedName

serializedName: string = "FaultId"

type

type: object

name

name: "Uuid" = "Uuid"

nodeName

nodeName: object

required

required: true = true

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

serviceManifestName

serviceManifestName: object

required

required: true = true

serializedName

serializedName: string = "ServiceManifestName"

type

type: object

name

name: "String" = "String"

servicePackageActivationId

servicePackageActivationId: object

required

required: true = true

serializedName

serializedName: string = "ServicePackageActivationId"

type

type: object

name

name: "String" = "String"

Const ChaosContext

ChaosContext: object

Describes a map, which is a collection of (string, string) type key-value pairs. The map can be used to record information about the Chaos run. There cannot be more than 100 such pairs and each string (key or value) can be at most 4095 characters long. This map is set by the starter of the Chaos run to optionally store the context about the specific run.

Optional map

map: undefined | object

Describes a map that contains a collection of ChaosContextMapItem's.

serializedName

serializedName: string = "ChaosContext"

type

type: object

className

className: string = "ChaosContext"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

map

map: object

serializedName

serializedName: string = "Map"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const ChaosEvent

ChaosEvent: object

Represents an event generated during a Chaos run.

kind

kind: "ChaosEvent"

Polymorphic Discriminator

timeStampUtc

timeStampUtc: Date

The UTC timestamp when this Chaos event was generated.

serializedName

serializedName: string = "ChaosEvent"

type

type: object

className

className: string = "ChaosEvent"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ChaosEvent"

modelProperties

modelProperties: object

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "Kind"

type

type: object

name

name: "String" = "String"

timeStampUtc

timeStampUtc: object

required

required: true = true

serializedName

serializedName: string = "TimeStampUtc"

type

type: object

name

name: "DateTime" = "DateTime"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "Kind"

Const ChaosEventWrapper

ChaosEventWrapper: object

Wrapper object for Chaos event.

Optional chaosEvent

chaosEvent: ChaosEventUnion

Represents an event generated during a Chaos run.

serializedName

serializedName: string = "ChaosEventWrapper"

type

type: object

className

className: string = "ChaosEventWrapper"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

chaosEvent

chaosEvent: object

serializedName

serializedName: string = "ChaosEvent"

type

type: object

className

className: string = "ChaosEvent"

name

name: "Composite" = "Composite"

Const ChaosEventsSegment

ChaosEventsSegment: object

Contains the list of Chaos events and the continuation token to get the next segment.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional history

List of Chaos events that meet the user-supplied criteria.

serializedName

serializedName: string = "ChaosEventsSegment"

type

type: object

className

className: string = "ChaosEventsSegment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

history

history: object

serializedName

serializedName: string = "History"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ChaosEventWrapper"

name

name: "Composite" = "Composite"

Const ChaosNodeRestartScheduledEvent

ChaosNodeRestartScheduledEvent: object

Chaos Restart Node Fault Scheduled event.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

faultGroupId

faultGroupId: string

Id of fault group.

faultId

faultId: string

Id of fault.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ChaosNodeRestartScheduled"

Polymorphic Discriminator

nodeInstanceId

nodeInstanceId: number

Id of Node instance.

nodeName

nodeName: string

The name of a Service Fabric node.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ChaosNodeRestartScheduled"

type

type: object

className

className: string = "ChaosNodeRestartScheduledEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

faultGroupId

faultGroupId: object

required

required: true = true

serializedName

serializedName: string = "FaultGroupId"

type

type: object

name

name: "Uuid" = "Uuid"

faultId

faultId: object

required

required: true = true

serializedName

serializedName: string = "FaultId"

type

type: object

name

name: "Uuid" = "Uuid"

nodeInstanceId

nodeInstanceId: object

required

required: true = true

serializedName

serializedName: string = "NodeInstanceId"

type

type: object

name

name: "Number" = "Number"

Const ChaosParameters

ChaosParameters: object

Defines all the parameters to configure a Chaos run.

Optional chaosTargetFilter

chaosTargetFilter: ChaosTargetFilter

List of cluster entities to target for Chaos faults. This filter can be used to target Chaos faults only to certain node types or only to certain application instances. If ChaosTargetFilter is not used, Chaos faults all cluster entities. If ChaosTargetFilter is used, Chaos faults only the entities that meet the ChaosTargetFilter specification.

Optional clusterHealthPolicy

clusterHealthPolicy: ClusterHealthPolicy

Passed-in cluster health policy is used to validate health of the cluster in between Chaos iterations. If the cluster health is in error or if an unexpected exception happens during fault execution--to provide the cluster with some time to recuperate--Chaos will wait for 30 minutes before the next health-check.

Optional context

context: ChaosContext

Describes a map, which is a collection of (string, string) type key-value pairs. The map can be used to record information about the Chaos run. There cannot be more than 100 such pairs and each string (key or value) can be at most 4095 characters long. This map is set by the starter of the Chaos run to optionally store the context about the specific run.

Optional enableMoveReplicaFaults

enableMoveReplicaFaults: undefined | false | true

Enables or disables the move primary and move secondary faults. Default value: true.

Optional maxClusterStabilizationTimeoutInSeconds

maxClusterStabilizationTimeoutInSeconds: undefined | number

The maximum amount of time to wait for all cluster entities to become stable and healthy. Chaos executes in iterations and at the start of each iteration it validates the health of cluster entities. During validation if a cluster entity is not stable and healthy within MaxClusterStabilizationTimeoutInSeconds, Chaos generates a validation failed event. Default value: 60.

Optional maxConcurrentFaults

maxConcurrentFaults: undefined | number

MaxConcurrentFaults is the maximum number of concurrent faults induced per iteration. Chaos executes in iterations and two consecutive iterations are separated by a validation phase. The higher the concurrency, the more aggressive the injection of faults, leading to inducing more complex series of states to uncover bugs. The recommendation is to start with a value of 2 or 3 and to exercise caution while moving up. Default value: 1.

Optional timeToRunInSeconds

timeToRunInSeconds: undefined | string

Total time (in seconds) for which Chaos will run before automatically stopping. The maximum allowed value is 4,294,967,295 (System.UInt32.MaxValue). Default value: '4294967295'.

Optional waitTimeBetweenFaultsInSeconds

waitTimeBetweenFaultsInSeconds: undefined | number

Wait time (in seconds) between consecutive faults within a single iteration. The larger the value, the lower the overlapping between faults and the simpler the sequence of state transitions that the cluster goes through. The recommendation is to start with a value between 1 and 5 and exercise caution while moving up. Default value: 20.

Optional waitTimeBetweenIterationsInSeconds

waitTimeBetweenIterationsInSeconds: undefined | number

Time-separation (in seconds) between two consecutive iterations of Chaos. The larger the value, the lower the fault injection rate. Default value: 30.

serializedName

serializedName: string = "ChaosParameters"

type

type: object

className

className: string = "ChaosParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

chaosTargetFilter

chaosTargetFilter: object

serializedName

serializedName: string = "ChaosTargetFilter"

type

type: object

className

className: string = "ChaosTargetFilter"

name

name: "Composite" = "Composite"

clusterHealthPolicy

clusterHealthPolicy: object

serializedName

serializedName: string = "ClusterHealthPolicy"

type

type: object

className

className: string = "ClusterHealthPolicy"

name

name: "Composite" = "Composite"

context

context: object

serializedName

serializedName: string = "Context"

type

type: object

className

className: string = "ChaosContext"

name

name: "Composite" = "Composite"

enableMoveReplicaFaults

enableMoveReplicaFaults: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "EnableMoveReplicaFaults"

type

type: object

name

name: "Boolean" = "Boolean"

maxClusterStabilizationTimeoutInSeconds

maxClusterStabilizationTimeoutInSeconds: object

defaultValue

defaultValue: number = 60

serializedName

serializedName: string = "MaxClusterStabilizationTimeoutInSeconds"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 4294967295

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

maxConcurrentFaults

maxConcurrentFaults: object

defaultValue

defaultValue: number = 1

serializedName

serializedName: string = "MaxConcurrentFaults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 4294967295

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

timeToRunInSeconds

timeToRunInSeconds: object

defaultValue

defaultValue: string = "4294967295"

serializedName

serializedName: string = "TimeToRunInSeconds"

type

type: object

name

name: "String" = "String"

waitTimeBetweenFaultsInSeconds

waitTimeBetweenFaultsInSeconds: object

defaultValue

defaultValue: number = 20

serializedName

serializedName: string = "WaitTimeBetweenFaultsInSeconds"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 4294967295

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

waitTimeBetweenIterationsInSeconds

waitTimeBetweenIterationsInSeconds: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "WaitTimeBetweenIterationsInSeconds"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 4294967295

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

Const ChaosParametersDictionaryItem

ChaosParametersDictionaryItem: object

Defines an item in ChaosParametersDictionary of the Chaos Schedule.

key

key: string

The key identifying the Chaos Parameter in the dictionary. This key is referenced by Chaos Schedule Jobs.

value

Defines all the parameters to configure a Chaos run.

serializedName

serializedName: string = "ChaosParametersDictionaryItem"

type

type: object

className

className: string = "ChaosParametersDictionaryItem"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

key

key: object

required

required: true = true

serializedName

serializedName: string = "Key"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "Value"

type

type: object

className

className: string = "ChaosParameters"

name

name: "Composite" = "Composite"

Const ChaosPartitionPrimaryMoveScheduledEvent

ChaosPartitionPrimaryMoveScheduledEvent: object

Chaos Move Primary Fault Scheduled event.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

faultGroupId

faultGroupId: string

Id of fault group.

faultId

faultId: string

Id of fault.

forcedMove

forcedMove: boolean

Indicates a forced move.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ChaosPartitionPrimaryMoveScheduled"

Polymorphic Discriminator

nodeTo

nodeTo: string

The name of a Service Fabric node.

partitionId

partitionId: string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

serviceName

serviceName: string

Service name.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ChaosPartitionPrimaryMoveScheduled"

type

type: object

className

className: string = "ChaosPartitionPrimaryMoveScheduledEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

faultGroupId

faultGroupId: object

required

required: true = true

serializedName

serializedName: string = "FaultGroupId"

type

type: object

name

name: "Uuid" = "Uuid"

faultId

faultId: object

required

required: true = true

serializedName

serializedName: string = "FaultId"

type

type: object

name

name: "Uuid" = "Uuid"

forcedMove

forcedMove: object

required

required: true = true

serializedName

serializedName: string = "ForcedMove"

type

type: object

name

name: "Boolean" = "Boolean"

nodeTo

nodeTo: object

required

required: true = true

serializedName

serializedName: string = "NodeTo"

type

type: object

name

name: "String" = "String"

serviceName

serviceName: object

required

required: true = true

serializedName

serializedName: string = "ServiceName"

type

type: object

name

name: "String" = "String"

Const ChaosPartitionSecondaryMoveScheduledEvent

ChaosPartitionSecondaryMoveScheduledEvent: object

Chaos Move Secondary Fault Scheduled event.

Optional category

category: undefined | string

The category of event.

destinationNode

destinationNode: string

The name of a Service Fabric node.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

faultGroupId

faultGroupId: string

Id of fault group.

faultId

faultId: string

Id of fault.

forcedMove

forcedMove: boolean

Indicates a forced move.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ChaosPartitionSecondaryMoveScheduled"

Polymorphic Discriminator

partitionId

partitionId: string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

serviceName

serviceName: string

Service name.

sourceNode

sourceNode: string

The name of a Service Fabric node.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ChaosPartitionSecondaryMoveScheduled"

type

type: object

className

className: string = "ChaosPartitionSecondaryMoveScheduledEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

destinationNode

destinationNode: object

required

required: true = true

serializedName

serializedName: string = "DestinationNode"

type

type: object

name

name: "String" = "String"

faultGroupId

faultGroupId: object

required

required: true = true

serializedName

serializedName: string = "FaultGroupId"

type

type: object

name

name: "Uuid" = "Uuid"

faultId

faultId: object

required

required: true = true

serializedName

serializedName: string = "FaultId"

type

type: object

name

name: "Uuid" = "Uuid"

forcedMove

forcedMove: object

required

required: true = true

serializedName

serializedName: string = "ForcedMove"

type

type: object

name

name: "Boolean" = "Boolean"

serviceName

serviceName: object

required

required: true = true

serializedName

serializedName: string = "ServiceName"

type

type: object

name

name: "String" = "String"

sourceNode

sourceNode: object

required

required: true = true

serializedName

serializedName: string = "SourceNode"

type

type: object

name

name: "String" = "String"

Const ChaosReplicaRemovalScheduledEvent

ChaosReplicaRemovalScheduledEvent: object

Chaos Remove Replica Fault Scheduled event.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

faultGroupId

faultGroupId: string

Id of fault group.

faultId

faultId: string

Id of fault.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ChaosReplicaRemovalScheduled"

Polymorphic Discriminator

partitionId

partitionId: string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

replicaId

replicaId: number

Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.

serviceUri

serviceUri: string

Service name.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ChaosReplicaRemovalScheduled"

type

type: object

className

className: string = "ChaosReplicaRemovalScheduledEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

faultGroupId

faultGroupId: object

required

required: true = true

serializedName

serializedName: string = "FaultGroupId"

type

type: object

name

name: "Uuid" = "Uuid"

faultId

faultId: object

required

required: true = true

serializedName

serializedName: string = "FaultId"

type

type: object

name

name: "Uuid" = "Uuid"

serviceUri

serviceUri: object

required

required: true = true

serializedName

serializedName: string = "ServiceUri"

type

type: object

name

name: "String" = "String"

Const ChaosReplicaRestartScheduledEvent

ChaosReplicaRestartScheduledEvent: object

Chaos Restart Replica Fault Scheduled event.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

faultGroupId

faultGroupId: string

Id of fault group.

faultId

faultId: string

Id of fault.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ChaosReplicaRestartScheduled"

Polymorphic Discriminator

partitionId

partitionId: string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

replicaId

replicaId: number

Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.

serviceUri

serviceUri: string

Service name.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ChaosReplicaRestartScheduled"

type

type: object

className

className: string = "ChaosReplicaRestartScheduledEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

faultGroupId

faultGroupId: object

required

required: true = true

serializedName

serializedName: string = "FaultGroupId"

type

type: object

name

name: "Uuid" = "Uuid"

faultId

faultId: object

required

required: true = true

serializedName

serializedName: string = "FaultId"

type

type: object

name

name: "Uuid" = "Uuid"

serviceUri

serviceUri: object

required

required: true = true

serializedName

serializedName: string = "ServiceUri"

type

type: object

name

name: "String" = "String"

Const ChaosSchedule

ChaosSchedule: object

Defines the schedule used by Chaos.

Optional chaosParametersDictionary

chaosParametersDictionary: ChaosParametersDictionaryItem[]

A mapping of string names to Chaos Parameters to be referenced by Chaos Schedule Jobs.

Optional expiryDate

expiryDate: Date

The date and time Chaos will continue to use this schedule until. Default value: new Date('9999-12-31T23:59:59.999Z').

Optional jobs

A list of all Chaos Schedule Jobs that will be automated by the schedule.

Optional startDate

startDate: Date

The date and time Chaos will start using this schedule. Default value: new Date('1601-01-01T00:00:00Z').

serializedName

serializedName: string = "ChaosSchedule"

type

type: object

className

className: string = "ChaosSchedule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

chaosParametersDictionary

chaosParametersDictionary: object

serializedName

serializedName: string = "ChaosParametersDictionary"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ChaosParametersDictionaryItem"

name

name: "Composite" = "Composite"

expiryDate

expiryDate: object

defaultValue

defaultValue: Date = new Date('9999-12-31T23:59:59.999Z')

serializedName

serializedName: string = "ExpiryDate"

type

type: object

name

name: "DateTime" = "DateTime"

jobs

jobs: object

serializedName

serializedName: string = "Jobs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ChaosScheduleJob"

name

name: "Composite" = "Composite"

startDate

startDate: object

defaultValue

defaultValue: Date = new Date('1601-01-01T00:00:00Z')

serializedName

serializedName: string = "StartDate"

type

type: object

name

name: "DateTime" = "DateTime"

Const ChaosScheduleDescription

ChaosScheduleDescription: object

Defines the Chaos Schedule used by Chaos and the version of the Chaos Schedule. The version value wraps back to 0 after surpassing 2,147,483,647.

Optional schedule

schedule: ChaosSchedule

Defines the schedule used by Chaos.

Optional version

version: undefined | number

The version number of the Schedule.

serializedName

serializedName: string = "ChaosScheduleDescription"

type

type: object

className

className: string = "ChaosScheduleDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

schedule

schedule: object

serializedName

serializedName: string = "Schedule"

type

type: object

className

className: string = "ChaosSchedule"

name

name: "Composite" = "Composite"

version

version: object

serializedName

serializedName: string = "Version"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

Const ChaosScheduleJob

ChaosScheduleJob: object

Defines a repetition rule and parameters of Chaos to be used with the Chaos Schedule.

Optional chaosParameters

chaosParameters: undefined | string

A reference to which Chaos Parameters of the Chaos Schedule to use.

Optional days

Defines the days of the week that a Chaos Schedule Job will run for.

Optional times

times: TimeRange[]

A list of Time Ranges that specify when during active days that this job will run. The times are interpreted as UTC.

serializedName

serializedName: string = "ChaosScheduleJob"

type

type: object

className

className: string = "ChaosScheduleJob"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

chaosParameters

chaosParameters: object

serializedName

serializedName: string = "ChaosParameters"

type

type: object

name

name: "String" = "String"

days

days: object

serializedName

serializedName: string = "Days"

type

type: object

className

className: string = "ChaosScheduleJobActiveDaysOfWeek"

name

name: "Composite" = "Composite"

times

times: object

serializedName

serializedName: string = "Times"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TimeRange"

name

name: "Composite" = "Composite"

Const ChaosScheduleJobActiveDaysOfWeek

ChaosScheduleJobActiveDaysOfWeek: object

Defines the days of the week that a Chaos Schedule Job will run for.

Optional friday

friday: undefined | false | true

Indicates if the Chaos Schedule Job will run on Friday. Default value: false.

Optional monday

monday: undefined | false | true

Indicates if the Chaos Schedule Job will run on Monday. Default value: false.

Optional saturday

saturday: undefined | false | true

Indicates if the Chaos Schedule Job will run on Saturday. Default value: false.

Optional sunday

sunday: undefined | false | true

Indicates if the Chaos Schedule Job will run on Sunday. Default value: false.

Optional thursday

thursday: undefined | false | true

Indicates if the Chaos Schedule Job will run on Thursday. Default value: false.

Optional tuesday

tuesday: undefined | false | true

Indicates if the Chaos Schedule Job will run on Tuesday. Default value: false.

Optional wednesday

wednesday: undefined | false | true

Indicates if the Chaos Schedule Job will run on Wednesday. Default value: false.

serializedName

serializedName: string = "ChaosScheduleJobActiveDaysOfWeek"

type

type: object

className

className: string = "ChaosScheduleJobActiveDaysOfWeek"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

friday

friday: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "Friday"

type

type: object

name

name: "Boolean" = "Boolean"

monday

monday: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "Monday"

type

type: object

name

name: "Boolean" = "Boolean"

saturday

saturday: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "Saturday"

type

type: object

name

name: "Boolean" = "Boolean"

sunday

sunday: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "Sunday"

type

type: object

name

name: "Boolean" = "Boolean"

thursday

thursday: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "Thursday"

type

type: object

name

name: "Boolean" = "Boolean"

tuesday

tuesday: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "Tuesday"

type

type: object

name

name: "Boolean" = "Boolean"

wednesday

wednesday: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "Wednesday"

type

type: object

name

name: "Boolean" = "Boolean"

Const ChaosStartedEvent

ChaosStartedEvent: object

Chaos Started event.

Optional category

category: undefined | string

The category of event.

chaosContext

chaosContext: string

Chaos Context.

clusterHealthPolicy

clusterHealthPolicy: string

Health policy.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

includedApplicationList

includedApplicationList: string

List of included Applications.

includedNodeTypeList

includedNodeTypeList: string

List of included Node types.

kind

kind: "ChaosStarted"

Polymorphic Discriminator

maxClusterStabilizationTimeoutInSeconds

maxClusterStabilizationTimeoutInSeconds: number

Maximum timeout for cluster stabilization in seconds.

maxConcurrentFaults

maxConcurrentFaults: number

Maximum number of concurrent faults.

moveReplicaFaultEnabled

moveReplicaFaultEnabled: boolean

Indicates MoveReplica fault is enabled.

timeStamp

timeStamp: Date

The time event was logged.

timeToRunInSeconds

timeToRunInSeconds: number

Time to run in seconds.

waitTimeBetweenFaultsInSeconds

waitTimeBetweenFaultsInSeconds: number

Wait time between faults in seconds.

waitTimeBetweenIterationsInSeconds

waitTimeBetweenIterationsInSeconds: number

Wait time between iterations in seconds.

serializedName

serializedName: string = "ChaosStarted"

type

type: object

className

className: string = "ChaosStartedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

chaosContext

chaosContext: object

required

required: true = true

serializedName

serializedName: string = "ChaosContext"

type

type: object

name

name: "String" = "String"

clusterHealthPolicy

clusterHealthPolicy: object

required

required: true = true

serializedName

serializedName: string = "ClusterHealthPolicy"

type

type: object

name

name: "String" = "String"

includedApplicationList

includedApplicationList: object

required

required: true = true

serializedName

serializedName: string = "IncludedApplicationList"

type

type: object

name

name: "String" = "String"

includedNodeTypeList

includedNodeTypeList: object

required

required: true = true

serializedName

serializedName: string = "IncludedNodeTypeList"

type

type: object

name

name: "String" = "String"

maxClusterStabilizationTimeoutInSeconds

maxClusterStabilizationTimeoutInSeconds: object

required

required: true = true

serializedName

serializedName: string = "MaxClusterStabilizationTimeoutInSeconds"

type

type: object

name

name: "Number" = "Number"

maxConcurrentFaults

maxConcurrentFaults: object

required

required: true = true

serializedName

serializedName: string = "MaxConcurrentFaults"

type

type: object

name

name: "Number" = "Number"

moveReplicaFaultEnabled

moveReplicaFaultEnabled: object

required

required: true = true

serializedName

serializedName: string = "MoveReplicaFaultEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

timeToRunInSeconds

timeToRunInSeconds: object

required

required: true = true

serializedName

serializedName: string = "TimeToRunInSeconds"

type

type: object

name

name: "Number" = "Number"

waitTimeBetweenFaultsInSeconds

waitTimeBetweenFaultsInSeconds: object

required

required: true = true

serializedName

serializedName: string = "WaitTimeBetweenFaultsInSeconds"

type

type: object

name

name: "Number" = "Number"

waitTimeBetweenIterationsInSeconds

waitTimeBetweenIterationsInSeconds: object

required

required: true = true

serializedName

serializedName: string = "WaitTimeBetweenIterationsInSeconds"

type

type: object

name

name: "Number" = "Number"

Const ChaosStoppedEvent

ChaosStoppedEvent: object

Chaos Stopped event.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ChaosStopped"

Polymorphic Discriminator

reason

reason: string

Describes reason.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ChaosStopped"

type

type: object

className

className: string = "ChaosStoppedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

reason

reason: object

required

required: true = true

serializedName

serializedName: string = "Reason"

type

type: object

name

name: "String" = "String"

Const ChaosTargetFilter

ChaosTargetFilter: object

Defines all filters for targeted Chaos faults, for example, faulting only certain node types or faulting only certain applications. If ChaosTargetFilter is not used, Chaos faults all cluster entities. If ChaosTargetFilter is used, Chaos faults only the entities that meet the ChaosTargetFilter specification. NodeTypeInclusionList and ApplicationInclusionList allow a union semantics only. It is not possible to specify an intersection of NodeTypeInclusionList and ApplicationInclusionList. For example, it is not possible to specify "fault this application only when it is on that node type." Once an entity is included in either NodeTypeInclusionList or ApplicationInclusionList, that entity cannot be excluded using ChaosTargetFilter. Even if applicationX does not appear in ApplicationInclusionList, in some Chaos iteration applicationX can be faulted because it happens to be on a node of nodeTypeY that is included in NodeTypeInclusionList. If both NodeTypeInclusionList and ApplicationInclusionList are null or empty, an ArgumentException is thrown.

Optional applicationInclusionList

applicationInclusionList: string[]

A list of application URIs to include in Chaos faults. All replicas belonging to services of these applications are amenable to replica faults (restart replica, remove replica, move primary, and move secondary) by Chaos. Chaos may restart a code package only if the code package hosts replicas of these applications only. If an application does not appear in this list, it can still be faulted in some Chaos iteration if the application ends up on a node of a node type that is included in NodeTypeInclusionList. However, if applicationX is tied to nodeTypeY through placement constraints and applicationX is absent from ApplicationInclusionList and nodeTypeY is absent from NodeTypeInclusionList, then applicationX will never be faulted. At most 1000 application names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfApplicationsInChaosEntityFilter configuration.

Optional nodeTypeInclusionList

nodeTypeInclusionList: string[]

A list of node types to include in Chaos faults. All types of faults (restart node, restart code package, remove replica, restart replica, move primary, and move secondary) are enabled for the nodes of these node types. If a node type (say NodeTypeX) does not appear in the NodeTypeInclusionList, then node level faults (like NodeRestart) will never be enabled for the nodes of NodeTypeX, but code package and replica faults can still be enabled for NodeTypeX if an application in the ApplicationInclusionList. happens to reside on a node of NodeTypeX. At most 100 node type names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfNodeTypesInChaosEntityFilter configuration.

serializedName

serializedName: string = "ChaosTargetFilter"

type

type: object

className

className: string = "ChaosTargetFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationInclusionList

applicationInclusionList: object

serializedName

serializedName: string = "ApplicationInclusionList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

nodeTypeInclusionList

nodeTypeInclusionList: object

serializedName

serializedName: string = "NodeTypeInclusionList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const CheckExistsPropertyBatchOperation

CheckExistsPropertyBatchOperation: object

Represents a PropertyBatchOperation that compares the Boolean existence of a property with the Exists argument. The PropertyBatchOperation operation fails if the property's existence is not equal to the Exists argument. The CheckExistsPropertyBatchOperation is generally used as a precondition for the write operations in the batch. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.

exists

exists: boolean

Whether or not the property should exist for the operation to pass.

kind

kind: "CheckExists"

Polymorphic Discriminator

propertyName

propertyName: string

The name of the Service Fabric property.

serializedName

serializedName: string = "CheckExists"

type

type: object

className

className: string = "CheckExistsPropertyBatchOperation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PropertyBatchOperation.type.polymorphicDiscriminator

uberParent

uberParent: string = "PropertyBatchOperation"

modelProperties

modelProperties: object

exists

exists: object

required

required: true = true

serializedName

serializedName: string = "Exists"

type

type: object

name

name: "Boolean" = "Boolean"

Const CheckSequencePropertyBatchOperation

CheckSequencePropertyBatchOperation: object

Compares the Sequence Number of a property with the SequenceNumber argument. A property's sequence number can be thought of as that property's version. Every time the property is modified, its sequence number is increased. The sequence number can be found in a property's metadata. The comparison fails if the sequence numbers are not equal. CheckSequencePropertyBatchOperation is generally used as a precondition for the write operations in the batch. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.

kind

kind: "CheckSequence"

Polymorphic Discriminator

propertyName

propertyName: string

The name of the Service Fabric property.

sequenceNumber

sequenceNumber: string

The expected sequence number.

serializedName

serializedName: string = "CheckSequence"

type

type: object

className

className: string = "CheckSequencePropertyBatchOperation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PropertyBatchOperation.type.polymorphicDiscriminator

uberParent

uberParent: string = "PropertyBatchOperation"

modelProperties

modelProperties: object

sequenceNumber

sequenceNumber: object

required

required: true = true

serializedName

serializedName: string = "SequenceNumber"

type

type: object

name

name: "String" = "String"

Const CheckValuePropertyBatchOperation

CheckValuePropertyBatchOperation: object

Represents a PropertyBatchOperation that compares the value of the property with the expected value. The CheckValuePropertyBatchOperation is generally used as a precondition for the write operations in the batch. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.

kind

kind: "CheckValue"

Polymorphic Discriminator

propertyName

propertyName: string

The name of the Service Fabric property.

value

The expected property value.

serializedName

serializedName: string = "CheckValue"

type

type: object

className

className: string = "CheckValuePropertyBatchOperation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PropertyBatchOperation.type.polymorphicDiscriminator

uberParent

uberParent: string = "PropertyBatchOperation"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = "Value"

type

type: object

className

className: string = "PropertyValue"

name

name: "Composite" = "Composite"

Const ClusterConfiguration

ClusterConfiguration: object

Information about the standalone cluster configuration.

Optional clusterConfiguration

clusterConfiguration: undefined | string

The contents of the cluster configuration file.

serializedName

serializedName: string = "ClusterConfiguration"

type

type: object

className

className: string = "ClusterConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clusterConfiguration

clusterConfiguration: object

serializedName

serializedName: string = "ClusterConfiguration"

type

type: object

name

name: "String" = "String"

Const ClusterConfigurationUpgradeDescription

ClusterConfigurationUpgradeDescription: object

Describes the parameters for a standalone cluster configuration upgrade.

Optional applicationHealthPolicies

applicationHealthPolicies: ApplicationHealthPolicies

Defines the application health policy map used to evaluate the health of an application or one of its children entities.

clusterConfig

clusterConfig: string

The cluster configuration as a JSON string. For example, this file contains JSON describing the nodes and other properties of the cluster.

Optional healthCheckRetryTimeout

healthCheckRetryTimeout: undefined | string

The length of time between attempts to perform health checks if the application or cluster is not healthy. Default value: 'PT0H0M0S'.

Optional healthCheckStableDurationInSeconds

healthCheckStableDurationInSeconds: undefined | string

The length of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. Default value: 'PT0H0M0S'.

Optional healthCheckWaitDurationInSeconds

healthCheckWaitDurationInSeconds: undefined | string

The length of time to wait after completing an upgrade domain before starting the health checks process. Default value: 'PT0H0M0S'.

Optional maxPercentDeltaUnhealthyNodes

maxPercentDeltaUnhealthyNodes: undefined | number

The maximum allowed percentage of delta health degradation during the upgrade. Allowed values are integer values from zero to 100. Default value: 0.

Optional maxPercentUnhealthyApplications

maxPercentUnhealthyApplications: undefined | number

The maximum allowed percentage of unhealthy applications during the upgrade. Allowed values are integer values from zero to 100. Default value: 0.

Optional maxPercentUnhealthyNodes

maxPercentUnhealthyNodes: undefined | number

The maximum allowed percentage of unhealthy nodes during the upgrade. Allowed values are integer values from zero to 100. Default value: 0.

Optional maxPercentUpgradeDomainDeltaUnhealthyNodes

maxPercentUpgradeDomainDeltaUnhealthyNodes: undefined | number

The maximum allowed percentage of upgrade domain delta health degradation during the upgrade. Allowed values are integer values from zero to 100. Default value: 0.

Optional upgradeDomainTimeoutInSeconds

upgradeDomainTimeoutInSeconds: undefined | string

The timeout for the upgrade domain. Default value: 'PT0H0M0S'.

Optional upgradeTimeoutInSeconds

upgradeTimeoutInSeconds: undefined | string

The upgrade timeout. Default value: 'PT0H0M0S'.

serializedName

serializedName: string = "ClusterConfigurationUpgradeDescription"

type

type: object

className

className: string = "ClusterConfigurationUpgradeDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationHealthPolicies

applicationHealthPolicies: object

serializedName

serializedName: string = "ApplicationHealthPolicies"

type

type: object

className

className: string = "ApplicationHealthPolicies"

name

name: "Composite" = "Composite"

clusterConfig

clusterConfig: object

required

required: true = true

serializedName

serializedName: string = "ClusterConfig"

type

type: object

name

name: "String" = "String"

healthCheckRetryTimeout

healthCheckRetryTimeout: object

defaultValue

defaultValue: string = "PT0H0M0S"

serializedName

serializedName: string = "HealthCheckRetryTimeout"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

healthCheckStableDurationInSeconds

healthCheckStableDurationInSeconds: object

defaultValue

defaultValue: string = "PT0H0M0S"

serializedName

serializedName: string = "HealthCheckStableDurationInSeconds"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

healthCheckWaitDurationInSeconds

healthCheckWaitDurationInSeconds: object

defaultValue

defaultValue: string = "PT0H0M0S"

serializedName

serializedName: string = "HealthCheckWaitDurationInSeconds"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

maxPercentDeltaUnhealthyNodes

maxPercentDeltaUnhealthyNodes: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "MaxPercentDeltaUnhealthyNodes"

type

type: object

name

name: "Number" = "Number"

maxPercentUnhealthyApplications

maxPercentUnhealthyApplications: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "MaxPercentUnhealthyApplications"

type

type: object

name

name: "Number" = "Number"

maxPercentUnhealthyNodes

maxPercentUnhealthyNodes: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "MaxPercentUnhealthyNodes"

type

type: object

name

name: "Number" = "Number"

maxPercentUpgradeDomainDeltaUnhealthyNodes

maxPercentUpgradeDomainDeltaUnhealthyNodes: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "MaxPercentUpgradeDomainDeltaUnhealthyNodes"

type

type: object

name

name: "Number" = "Number"

upgradeDomainTimeoutInSeconds

upgradeDomainTimeoutInSeconds: object

defaultValue

defaultValue: string = "PT0H0M0S"

serializedName

serializedName: string = "UpgradeDomainTimeoutInSeconds"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

upgradeTimeoutInSeconds

upgradeTimeoutInSeconds: object

defaultValue

defaultValue: string = "PT0H0M0S"

serializedName

serializedName: string = "UpgradeTimeoutInSeconds"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const ClusterConfigurationUpgradeStatusInfo

ClusterConfigurationUpgradeStatusInfo: object

Information about a standalone cluster configuration upgrade status.

Optional configVersion

configVersion: undefined | string

The cluster configuration version.

Optional details

details: undefined | string

The cluster upgrade status details.

Optional progressStatus

progressStatus: undefined | number

The cluster manifest version.

Optional upgradeState

upgradeState: UpgradeState

The state of the upgrade domain. Possible values include: 'Invalid', 'RollingBackInProgress', 'RollingBackCompleted', 'RollingForwardPending', 'RollingForwardInProgress', 'RollingForwardCompleted', 'Failed'

serializedName

serializedName: string = "ClusterConfigurationUpgradeStatusInfo"

type

type: object

className

className: string = "ClusterConfigurationUpgradeStatusInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

configVersion

configVersion: object

serializedName

serializedName: string = "ConfigVersion"

type

type: object

name

name: "String" = "String"

details

details: object

serializedName

serializedName: string = "Details"

type

type: object

name

name: "String" = "String"

progressStatus

progressStatus: object

serializedName

serializedName: string = "ProgressStatus"

type

type: object

name

name: "Number" = "Number"

upgradeState

upgradeState: object

serializedName

serializedName: string = "UpgradeState"

type

type: object

name

name: "String" = "String"

Const ClusterEvent

ClusterEvent: object

Represents the base for all Cluster Events.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ClusterEvent"

Polymorphic Discriminator

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ClusterEvent"

type

type: object

className

className: string = "ClusterEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

Const ClusterHealth

ClusterHealth: object

Represents the health of the cluster. Contains the cluster aggregated health state, the cluster application and node health states as well as the health events and the unhealthy evaluations.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional applicationHealthStates

applicationHealthStates: ApplicationHealthState[]

Cluster application health states as found in the health store.

Optional healthEvents

healthEvents: HealthEvent[]

The list of health events reported on the entity.

Optional healthStatistics

healthStatistics: HealthStatistics

Shows the health statistics for all children types of the queried entity.

Optional nodeHealthStates

nodeHealthStates: NodeHealthState[]

Cluster node health states as found in the health store.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.

serializedName

serializedName: string = "ClusterHealth"

type

type: object

className

className: string = "ClusterHealth"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationHealthStates

applicationHealthStates: object

serializedName

serializedName: string = "ApplicationHealthStates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationHealthState"

name

name: "Composite" = "Composite"

nodeHealthStates

nodeHealthStates: object

serializedName

serializedName: string = "NodeHealthStates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NodeHealthState"

name

name: "Composite" = "Composite"

Const ClusterHealthChunk

ClusterHealthChunk: object

Represents the health chunk of the cluster. Contains the cluster aggregated health state, and the cluster entities that respect the input filter.

Optional applicationHealthStateChunks

applicationHealthStateChunks: ApplicationHealthStateChunkList

The list of application health state chunks in the cluster that respect the filters in the cluster health chunk query description.

Optional healthState

healthState: HealthState

The HealthState representing the aggregated health state of the cluster computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired cluster health policy and the application health policies. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional nodeHealthStateChunks

nodeHealthStateChunks: NodeHealthStateChunkList

The list of node health state chunks in the cluster that respect the filters in the cluster health chunk query description.

serializedName

serializedName: string = "ClusterHealthChunk"

type

type: object

className

className: string = "ClusterHealthChunk"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationHealthStateChunks

applicationHealthStateChunks: object

serializedName

serializedName: string = "ApplicationHealthStateChunks"

type

type: object

className

className: string = "ApplicationHealthStateChunkList"

name

name: "Composite" = "Composite"

healthState

healthState: object

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

nodeHealthStateChunks

nodeHealthStateChunks: object

serializedName

serializedName: string = "NodeHealthStateChunks"

type

type: object

className

className: string = "NodeHealthStateChunkList"

name

name: "Composite" = "Composite"

Const ClusterHealthChunkQueryDescription

ClusterHealthChunkQueryDescription: object

The cluster health chunk query description, which can specify the health policies to evaluate cluster health and very expressive filters to select which cluster entities to include in response.

Optional applicationFilters

applicationFilters: ApplicationHealthStateFilter[]

Defines a list of filters that specify which applications to be included in the returned cluster health chunk. If no filters are specified, no applications are returned. All the applications are used to evaluate the cluster's aggregated health state, regardless of the input filters. The cluster health chunk query may specify multiple application filters. For example, it can specify a filter to return all applications with health state Error and another filter to always include applications of a specified application type.

Optional applicationHealthPolicies

applicationHealthPolicies: ApplicationHealthPolicies

Defines the application health policy map used to evaluate the health of an application or one of its children entities.

Optional clusterHealthPolicy

clusterHealthPolicy: ClusterHealthPolicy

Defines a health policy used to evaluate the health of the cluster or of a cluster node.

Optional nodeFilters

nodeFilters: NodeHealthStateFilter[]

Defines a list of filters that specify which nodes to be included in the returned cluster health chunk. If no filters are specified, no nodes are returned. All the nodes are used to evaluate the cluster's aggregated health state, regardless of the input filters. The cluster health chunk query may specify multiple node filters. For example, it can specify a filter to return all nodes with health state Error and another filter to always include a node identified by its NodeName.

serializedName

serializedName: string = "ClusterHealthChunkQueryDescription"

type

type: object

className

className: string = "ClusterHealthChunkQueryDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationFilters

applicationFilters: object

serializedName

serializedName: string = "ApplicationFilters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationHealthStateFilter"

name

name: "Composite" = "Composite"

applicationHealthPolicies

applicationHealthPolicies: object

serializedName

serializedName: string = "ApplicationHealthPolicies"

type

type: object

className

className: string = "ApplicationHealthPolicies"

name

name: "Composite" = "Composite"

clusterHealthPolicy

clusterHealthPolicy: object

serializedName

serializedName: string = "ClusterHealthPolicy"

type

type: object

className

className: string = "ClusterHealthPolicy"

name

name: "Composite" = "Composite"

nodeFilters

nodeFilters: object

serializedName

serializedName: string = "NodeFilters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NodeHealthStateFilter"

name

name: "Composite" = "Composite"

Const ClusterHealthPolicies

ClusterHealthPolicies: object

Health policies to evaluate cluster health.

Optional applicationHealthPolicyMap

applicationHealthPolicyMap: ApplicationHealthPolicyMapItem[]

Defines a map that contains specific application health policies for different applications. Each entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health. If an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest). The map is empty by default.

Optional clusterHealthPolicy

clusterHealthPolicy: ClusterHealthPolicy

Defines a health policy used to evaluate the health of the cluster or of a cluster node.

serializedName

serializedName: string = "ClusterHealthPolicies"

type

type: object

className

className: string = "ClusterHealthPolicies"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationHealthPolicyMap

applicationHealthPolicyMap: object

serializedName

serializedName: string = "ApplicationHealthPolicyMap"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationHealthPolicyMapItem"

name

name: "Composite" = "Composite"

clusterHealthPolicy

clusterHealthPolicy: object

serializedName

serializedName: string = "ClusterHealthPolicy"

type

type: object

className

className: string = "ClusterHealthPolicy"

name

name: "Composite" = "Composite"

Const ClusterHealthPolicy

ClusterHealthPolicy: object

Defines a health policy used to evaluate the health of the cluster or of a cluster node.

Optional applicationTypeHealthPolicyMap

applicationTypeHealthPolicyMap: ApplicationTypeHealthPolicyMapItem[]

Defines a map with max percentage unhealthy applications for specific application types. Each entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type.

The application type health policy map can be used during cluster health evaluation to describe special application types. The application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy. The applications of application types specified in the map are not counted against the global pool of applications. For example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type and assign it a value of 0% (that is, do not tolerate any failures). All other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances. The application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation.

Optional considerWarningAsError

considerWarningAsError: undefined | false | true

Indicates whether warnings are treated with the same severity as errors. Default value: false.

Optional maxPercentUnhealthyApplications

maxPercentUnhealthyApplications: undefined | number

The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.

The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. Default value: 0.

Optional maxPercentUnhealthyNodes

maxPercentUnhealthyNodes: undefined | number

The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.

The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.

In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. Default value: 0.

serializedName

serializedName: string = "ClusterHealthPolicy"

type

type: object

className

className: string = "ClusterHealthPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationTypeHealthPolicyMap

applicationTypeHealthPolicyMap: object

serializedName

serializedName: string = "ApplicationTypeHealthPolicyMap"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationTypeHealthPolicyMapItem"

name

name: "Composite" = "Composite"

considerWarningAsError

considerWarningAsError: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "ConsiderWarningAsError"

type

type: object

name

name: "Boolean" = "Boolean"

maxPercentUnhealthyApplications

maxPercentUnhealthyApplications: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "MaxPercentUnhealthyApplications"

type

type: object

name

name: "Number" = "Number"

maxPercentUnhealthyNodes

maxPercentUnhealthyNodes: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "MaxPercentUnhealthyNodes"

type

type: object

name

name: "Number" = "Number"

Const ClusterHealthReportExpiredEvent

ClusterHealthReportExpiredEvent: object

Cluster Health Report Expired event.

Optional category

category: undefined | string

The category of event.

description

description: string

Description of report.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

healthState

healthState: string

Describes the property health state.

kind

kind: "ClusterHealthReportExpired"

Polymorphic Discriminator

property

property: string

Describes the property.

removeWhenExpired

removeWhenExpired: boolean

Indicates the removal when it expires.

sequenceNumber

sequenceNumber: number

Sequence number of report.

sourceId

sourceId: string

Id of report source.

sourceUtcTimestamp

sourceUtcTimestamp: Date

Source time.

timeStamp

timeStamp: Date

The time event was logged.

timeToLiveMs

timeToLiveMs: number

Time to live in milli-seconds.

serializedName

serializedName: string = "ClusterHealthReportExpired"

type

type: object

className

className: string = "ClusterHealthReportExpiredEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

description

description: object

required

required: true = true

serializedName

serializedName: string = "Description"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

required

required: true = true

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

property

property: object

required

required: true = true

serializedName

serializedName: string = "Property"

type

type: object

name

name: "String" = "String"

removeWhenExpired

removeWhenExpired: object

required

required: true = true

serializedName

serializedName: string = "RemoveWhenExpired"

type

type: object

name

name: "Boolean" = "Boolean"

sequenceNumber

sequenceNumber: object

required

required: true = true

serializedName

serializedName: string = "SequenceNumber"

type

type: object

name

name: "Number" = "Number"

sourceId

sourceId: object

required

required: true = true

serializedName

serializedName: string = "SourceId"

type

type: object

name

name: "String" = "String"

sourceUtcTimestamp

sourceUtcTimestamp: object

required

required: true = true

serializedName

serializedName: string = "SourceUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

timeToLiveMs

timeToLiveMs: object

required

required: true = true

serializedName

serializedName: string = "TimeToLiveMs"

type

type: object

name

name: "Number" = "Number"

Const ClusterLoadInfo

ClusterLoadInfo: object

Information about load in a Service Fabric cluster. It holds a summary of all metrics and their load in a cluster.

Optional lastBalancingEndTimeUtc

lastBalancingEndTimeUtc: Date

The end time of last resource balancing run.

Optional lastBalancingStartTimeUtc

lastBalancingStartTimeUtc: Date

The starting time of last resource balancing run.

Optional loadMetricInformation

loadMetricInformation: LoadMetricInformation[]

List that contains metrics and their load information in this cluster.

serializedName

serializedName: string = "ClusterLoadInfo"

type

type: object

className

className: string = "ClusterLoadInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

lastBalancingEndTimeUtc

lastBalancingEndTimeUtc: object

serializedName

serializedName: string = "LastBalancingEndTimeUtc"

type

type: object

name

name: "DateTime" = "DateTime"

lastBalancingStartTimeUtc

lastBalancingStartTimeUtc: object

serializedName

serializedName: string = "LastBalancingStartTimeUtc"

type

type: object

name

name: "DateTime" = "DateTime"

loadMetricInformation

loadMetricInformation: object

serializedName

serializedName: string = "LoadMetricInformation"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LoadMetricInformation"

name

name: "Composite" = "Composite"

Const ClusterManifest

ClusterManifest: object

Information about the cluster manifest.

Optional manifest

manifest: undefined | string

The contents of the cluster manifest file.

serializedName

serializedName: string = "ClusterManifest"

type

type: object

className

className: string = "ClusterManifest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

manifest

manifest: object

serializedName

serializedName: string = "Manifest"

type

type: object

name

name: "String" = "String"

Const ClusterNewHealthReportEvent

ClusterNewHealthReportEvent: object

Cluster Health Report Created event.

Optional category

category: undefined | string

The category of event.

description

description: string

Description of report.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

healthState

healthState: string

Describes the property health state.

kind

kind: "ClusterNewHealthReport"

Polymorphic Discriminator

property

property: string

Describes the property.

removeWhenExpired

removeWhenExpired: boolean

Indicates the removal when it expires.

sequenceNumber

sequenceNumber: number

Sequence number of report.

sourceId

sourceId: string

Id of report source.

sourceUtcTimestamp

sourceUtcTimestamp: Date

Source time.

timeStamp

timeStamp: Date

The time event was logged.

timeToLiveMs

timeToLiveMs: number

Time to live in milli-seconds.

serializedName

serializedName: string = "ClusterNewHealthReport"

type

type: object

className

className: string = "ClusterNewHealthReportEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

description

description: object

required

required: true = true

serializedName

serializedName: string = "Description"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

required

required: true = true

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

property

property: object

required

required: true = true

serializedName

serializedName: string = "Property"

type

type: object

name

name: "String" = "String"

removeWhenExpired

removeWhenExpired: object

required

required: true = true

serializedName

serializedName: string = "RemoveWhenExpired"

type

type: object

name

name: "Boolean" = "Boolean"

sequenceNumber

sequenceNumber: object

required

required: true = true

serializedName

serializedName: string = "SequenceNumber"

type

type: object

name

name: "Number" = "Number"

sourceId

sourceId: object

required

required: true = true

serializedName

serializedName: string = "SourceId"

type

type: object

name

name: "String" = "String"

sourceUtcTimestamp

sourceUtcTimestamp: object

required

required: true = true

serializedName

serializedName: string = "SourceUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

timeToLiveMs

timeToLiveMs: object

required

required: true = true

serializedName

serializedName: string = "TimeToLiveMs"

type

type: object

name

name: "Number" = "Number"

Const ClusterUpgradeCompletedEvent

ClusterUpgradeCompletedEvent: object

Cluster Upgrade Completed event.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ClusterUpgradeCompleted"

Polymorphic Discriminator

overallUpgradeElapsedTimeInMs

overallUpgradeElapsedTimeInMs: number

Overall duration of upgrade in milli-seconds.

targetClusterVersion

targetClusterVersion: string

Target Cluster version.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ClusterUpgradeCompleted"

type

type: object

className

className: string = "ClusterUpgradeCompletedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

overallUpgradeElapsedTimeInMs

overallUpgradeElapsedTimeInMs: object

required

required: true = true

serializedName

serializedName: string = "OverallUpgradeElapsedTimeInMs"

type

type: object

name

name: "Number" = "Number"

targetClusterVersion

targetClusterVersion: object

required

required: true = true

serializedName

serializedName: string = "TargetClusterVersion"

type

type: object

name

name: "String" = "String"

Const ClusterUpgradeDescriptionObject

ClusterUpgradeDescriptionObject: object

Represents a ServiceFabric cluster upgrade

Optional applicationHealthPolicyMap

applicationHealthPolicyMap: ApplicationHealthPolicyMapItem[]

Defines a map that contains specific application health policies for different applications. Each entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health. If an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest). The map is empty by default.

Optional clusterHealthPolicy

clusterHealthPolicy: ClusterHealthPolicy

Defines a health policy used to evaluate the health of the cluster or of a cluster node.

Optional clusterUpgradeHealthPolicy

clusterUpgradeHealthPolicy: ClusterUpgradeHealthPolicyObject

Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.

Optional codeVersion

codeVersion: undefined | string

The ServiceFabric code version of the cluster.

Optional configVersion

configVersion: undefined | string

The cluster configuration version (specified in the cluster manifest).

Optional enableDeltaHealthEvaluation

enableDeltaHealthEvaluation: undefined | false | true

When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain.

Optional forceRestart

forceRestart: undefined | false | true

If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).

Optional monitoringPolicy

monitoringPolicy: MonitoringPolicyDescription

Describes the parameters for monitoring an upgrade in Monitored mode.

Optional rollingUpgradeMode

rollingUpgradeMode: UpgradeMode

The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Default value: 'UnmonitoredAuto'.

Optional sortOrder

sortOrder: UpgradeSortOrder

Defines the order in which an upgrade proceeds through the cluster. Possible values include: 'Invalid', 'Default', 'Numeric', 'Lexicographical', 'ReverseNumeric', 'ReverseLexicographical'. Default value: 'Default'.

Optional upgradeKind

upgradeKind: UpgradeKind

The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling'. Default value: 'Rolling'.

Optional upgradeReplicaSetCheckTimeoutInSeconds

upgradeReplicaSetCheckTimeoutInSeconds: undefined | number

The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).

serializedName

serializedName: string = "ClusterUpgradeDescriptionObject"

type

type: object

className

className: string = "ClusterUpgradeDescriptionObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationHealthPolicyMap

applicationHealthPolicyMap: object

serializedName

serializedName: string = "ApplicationHealthPolicyMap"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationHealthPolicyMapItem"

name

name: "Composite" = "Composite"

clusterHealthPolicy

clusterHealthPolicy: object

serializedName

serializedName: string = "ClusterHealthPolicy"

type

type: object

className

className: string = "ClusterHealthPolicy"

name

name: "Composite" = "Composite"

clusterUpgradeHealthPolicy

clusterUpgradeHealthPolicy: object

serializedName

serializedName: string = "ClusterUpgradeHealthPolicy"

type

type: object

className

className: string = "ClusterUpgradeHealthPolicyObject"

name

name: "Composite" = "Composite"

codeVersion

codeVersion: object

serializedName

serializedName: string = "CodeVersion"

type

type: object

name

name: "String" = "String"

configVersion

configVersion: object

serializedName

serializedName: string = "ConfigVersion"

type

type: object

name

name: "String" = "String"

enableDeltaHealthEvaluation

enableDeltaHealthEvaluation: object

serializedName

serializedName: string = "EnableDeltaHealthEvaluation"

type

type: object

name

name: "Boolean" = "Boolean"

forceRestart

forceRestart: object

serializedName

serializedName: string = "ForceRestart"

type

type: object

name

name: "Boolean" = "Boolean"

monitoringPolicy

monitoringPolicy: object

serializedName

serializedName: string = "MonitoringPolicy"

type

type: object

className

className: string = "MonitoringPolicyDescription"

name

name: "Composite" = "Composite"

rollingUpgradeMode

rollingUpgradeMode: object

defaultValue

defaultValue: string = "UnmonitoredAuto"

serializedName

serializedName: string = "RollingUpgradeMode"

type

type: object

name

name: "String" = "String"

sortOrder

sortOrder: object

defaultValue

defaultValue: string = "Default"

serializedName

serializedName: string = "SortOrder"

type

type: object

name

name: "String" = "String"

upgradeKind

upgradeKind: object

defaultValue

defaultValue: string = "Rolling"

serializedName

serializedName: string = "UpgradeKind"

type

type: object

name

name: "String" = "String"

upgradeReplicaSetCheckTimeoutInSeconds

upgradeReplicaSetCheckTimeoutInSeconds: object

serializedName

serializedName: string = "UpgradeReplicaSetCheckTimeoutInSeconds"

type

type: object

name

name: "Number" = "Number"

Const ClusterUpgradeDomainCompletedEvent

ClusterUpgradeDomainCompletedEvent: object

Cluster Upgrade Domain Completed event.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ClusterUpgradeDomainCompleted"

Polymorphic Discriminator

targetClusterVersion

targetClusterVersion: string

Target Cluster version.

timeStamp

timeStamp: Date

The time event was logged.

upgradeDomainElapsedTimeInMs

upgradeDomainElapsedTimeInMs: number

Duration of domain upgrade in milli-seconds.

upgradeDomains

upgradeDomains: string

Upgrade domains.

upgradeState

upgradeState: string

State of upgrade.

serializedName

serializedName: string = "ClusterUpgradeDomainCompleted"

type

type: object

className

className: string = "ClusterUpgradeDomainCompletedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

targetClusterVersion

targetClusterVersion: object

required

required: true = true

serializedName

serializedName: string = "TargetClusterVersion"

type

type: object

name

name: "String" = "String"

upgradeDomainElapsedTimeInMs

upgradeDomainElapsedTimeInMs: object

required

required: true = true

serializedName

serializedName: string = "UpgradeDomainElapsedTimeInMs"

type

type: object

name

name: "Number" = "Number"

upgradeDomains

upgradeDomains: object

required

required: true = true

serializedName

serializedName: string = "UpgradeDomains"

type

type: object

name

name: "String" = "String"

upgradeState

upgradeState: object

required

required: true = true

serializedName

serializedName: string = "UpgradeState"

type

type: object

name

name: "String" = "String"

Const ClusterUpgradeHealthPolicyObject

ClusterUpgradeHealthPolicyObject: object

Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.

Optional maxPercentDeltaUnhealthyNodes

maxPercentDeltaUnhealthyNodes: undefined | number

The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. The default value is 10%.

Optional maxPercentUpgradeDomainDeltaUnhealthyNodes

maxPercentUpgradeDomainDeltaUnhealthyNodes: undefined | number

The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. The default value is 15%.

serializedName

serializedName: string = "ClusterUpgradeHealthPolicyObject"

type

type: object

className

className: string = "ClusterUpgradeHealthPolicyObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

maxPercentDeltaUnhealthyNodes

maxPercentDeltaUnhealthyNodes: object

serializedName

serializedName: string = "MaxPercentDeltaUnhealthyNodes"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 100

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

maxPercentUpgradeDomainDeltaUnhealthyNodes

maxPercentUpgradeDomainDeltaUnhealthyNodes: object

serializedName

serializedName: string = "MaxPercentUpgradeDomainDeltaUnhealthyNodes"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 100

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

Const ClusterUpgradeProgressObject

ClusterUpgradeProgressObject: object

Information about a cluster upgrade.

Optional codeVersion

codeVersion: undefined | string

The ServiceFabric code version of the cluster.

Optional configVersion

configVersion: undefined | string

The cluster configuration version (specified in the cluster manifest).

Optional currentUpgradeDomainProgress

currentUpgradeDomainProgress: CurrentUpgradeDomainProgressInfo

Information about the current in-progress upgrade domain.

Optional failureReason

failureReason: FailureReason

The cause of an upgrade failure that resulted in FailureAction being executed. Possible values include: 'None', 'Interrupted', 'HealthCheck', 'UpgradeDomainTimeout', 'OverallUpgradeTimeout'

Optional failureTimestampUtc

failureTimestampUtc: undefined | string

The failure time of the upgrade in UTC.

Optional nextUpgradeDomain

nextUpgradeDomain: undefined | string

The name of the next upgrade domain to be processed.

Optional rollingUpgradeMode

rollingUpgradeMode: UpgradeMode

The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Default value: 'UnmonitoredAuto'.

Optional startTimestampUtc

startTimestampUtc: undefined | string

The start time of the upgrade in UTC.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

List of health evaluations that resulted in the current aggregated health state.

Optional upgradeDescription

Represents a ServiceFabric cluster upgrade

Optional upgradeDomainDurationInMilliseconds

upgradeDomainDurationInMilliseconds: undefined | string

The estimated elapsed time spent processing the current upgrade domain.

Optional upgradeDomainProgressAtFailure

upgradeDomainProgressAtFailure: FailedUpgradeDomainProgressObject

The detailed upgrade progress for nodes in the current upgrade domain at the point of failure.

Optional upgradeDomains

upgradeDomains: UpgradeDomainInfo[]

List of upgrade domains and their statuses.

Optional upgradeDurationInMilliseconds

upgradeDurationInMilliseconds: undefined | string

The estimated elapsed time spent processing the current overall upgrade.

Optional upgradeState

upgradeState: UpgradeState

The state of the upgrade domain. Possible values include: 'Invalid', 'RollingBackInProgress', 'RollingBackCompleted', 'RollingForwardPending', 'RollingForwardInProgress', 'RollingForwardCompleted', 'Failed'

serializedName

serializedName: string = "ClusterUpgradeProgressObject"

type

type: object

className

className: string = "ClusterUpgradeProgressObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

codeVersion

codeVersion: object

serializedName

serializedName: string = "CodeVersion"

type

type: object

name

name: "String" = "String"

configVersion

configVersion: object

serializedName

serializedName: string = "ConfigVersion"

type

type: object

name

name: "String" = "String"

currentUpgradeDomainProgress

currentUpgradeDomainProgress: object

serializedName

serializedName: string = "CurrentUpgradeDomainProgress"

type

type: object

className

className: string = "CurrentUpgradeDomainProgressInfo"

name

name: "Composite" = "Composite"

failureReason

failureReason: object

serializedName

serializedName: string = "FailureReason"

type

type: object

name

name: "String" = "String"

failureTimestampUtc

failureTimestampUtc: object

serializedName

serializedName: string = "FailureTimestampUtc"

type

type: object

name

name: "String" = "String"

nextUpgradeDomain

nextUpgradeDomain: object

serializedName

serializedName: string = "NextUpgradeDomain"

type

type: object

name

name: "String" = "String"

rollingUpgradeMode

rollingUpgradeMode: object

defaultValue

defaultValue: string = "UnmonitoredAuto"

serializedName

serializedName: string = "RollingUpgradeMode"

type

type: object

name

name: "String" = "String"

startTimestampUtc

startTimestampUtc: object

serializedName

serializedName: string = "StartTimestampUtc"

type

type: object

name

name: "String" = "String"

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

upgradeDescription

upgradeDescription: object

serializedName

serializedName: string = "UpgradeDescription"

type

type: object

className

className: string = "ClusterUpgradeDescriptionObject"

name

name: "Composite" = "Composite"

upgradeDomainDurationInMilliseconds

upgradeDomainDurationInMilliseconds: object

serializedName

serializedName: string = "UpgradeDomainDurationInMilliseconds"

type

type: object

name

name: "String" = "String"

upgradeDomainProgressAtFailure

upgradeDomainProgressAtFailure: object

serializedName

serializedName: string = "UpgradeDomainProgressAtFailure"

type

type: object

className

className: string = "FailedUpgradeDomainProgressObject"

name

name: "Composite" = "Composite"

upgradeDomains

upgradeDomains: object

serializedName

serializedName: string = "UpgradeDomains"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "UpgradeDomainInfo"

name

name: "Composite" = "Composite"

upgradeDurationInMilliseconds

upgradeDurationInMilliseconds: object

serializedName

serializedName: string = "UpgradeDurationInMilliseconds"

type

type: object

name

name: "String" = "String"

upgradeState

upgradeState: object

serializedName

serializedName: string = "UpgradeState"

type

type: object

name

name: "String" = "String"

Const ClusterUpgradeRollbackCompletedEvent

ClusterUpgradeRollbackCompletedEvent: object

Cluster Upgrade Rollback Completed event.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

failureReason

failureReason: string

Describes failure.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ClusterUpgradeRollbackCompleted"

Polymorphic Discriminator

overallUpgradeElapsedTimeInMs

overallUpgradeElapsedTimeInMs: number

Overall duration of upgrade in milli-seconds.

targetClusterVersion

targetClusterVersion: string

Target Cluster version.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ClusterUpgradeRollbackCompleted"

type

type: object

className

className: string = "ClusterUpgradeRollbackCompletedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

failureReason

failureReason: object

required

required: true = true

serializedName

serializedName: string = "FailureReason"

type

type: object

name

name: "String" = "String"

overallUpgradeElapsedTimeInMs

overallUpgradeElapsedTimeInMs: object

required

required: true = true

serializedName

serializedName: string = "OverallUpgradeElapsedTimeInMs"

type

type: object

name

name: "Number" = "Number"

targetClusterVersion

targetClusterVersion: object

required

required: true = true

serializedName

serializedName: string = "TargetClusterVersion"

type

type: object

name

name: "String" = "String"

Const ClusterUpgradeRollbackStartedEvent

ClusterUpgradeRollbackStartedEvent: object

Cluster Upgrade Rollback Started event.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

failureReason

failureReason: string

Describes failure.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ClusterUpgradeRollbackStarted"

Polymorphic Discriminator

overallUpgradeElapsedTimeInMs

overallUpgradeElapsedTimeInMs: number

Overall duration of upgrade in milli-seconds.

targetClusterVersion

targetClusterVersion: string

Target Cluster version.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ClusterUpgradeRollbackStarted"

type

type: object

className

className: string = "ClusterUpgradeRollbackStartedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

failureReason

failureReason: object

required

required: true = true

serializedName

serializedName: string = "FailureReason"

type

type: object

name

name: "String" = "String"

overallUpgradeElapsedTimeInMs

overallUpgradeElapsedTimeInMs: object

required

required: true = true

serializedName

serializedName: string = "OverallUpgradeElapsedTimeInMs"

type

type: object

name

name: "Number" = "Number"

targetClusterVersion

targetClusterVersion: object

required

required: true = true

serializedName

serializedName: string = "TargetClusterVersion"

type

type: object

name

name: "String" = "String"

Const ClusterUpgradeStartedEvent

ClusterUpgradeStartedEvent: object

Cluster Upgrade Started event.

Optional category

category: undefined | string

The category of event.

currentClusterVersion

currentClusterVersion: string

Current Cluster version.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

failureAction

failureAction: string

Action if failed.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ClusterUpgradeStarted"

Polymorphic Discriminator

rollingUpgradeMode

rollingUpgradeMode: string

Mode of upgrade.

targetClusterVersion

targetClusterVersion: string

Target Cluster version.

timeStamp

timeStamp: Date

The time event was logged.

upgradeType

upgradeType: string

Type of upgrade.

serializedName

serializedName: string = "ClusterUpgradeStarted"

type

type: object

className

className: string = "ClusterUpgradeStartedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

currentClusterVersion

currentClusterVersion: object

required

required: true = true

serializedName

serializedName: string = "CurrentClusterVersion"

type

type: object

name

name: "String" = "String"

failureAction

failureAction: object

required

required: true = true

serializedName

serializedName: string = "FailureAction"

type

type: object

name

name: "String" = "String"

rollingUpgradeMode

rollingUpgradeMode: object

required

required: true = true

serializedName

serializedName: string = "RollingUpgradeMode"

type

type: object

name

name: "String" = "String"

targetClusterVersion

targetClusterVersion: object

required

required: true = true

serializedName

serializedName: string = "TargetClusterVersion"

type

type: object

name

name: "String" = "String"

upgradeType

upgradeType: object

required

required: true = true

serializedName

serializedName: string = "UpgradeType"

type

type: object

name

name: "String" = "String"

Const ClusterVersion

ClusterVersion: object

The cluster version.

Optional version

version: undefined | string

The Service Fabric cluster runtime version.

serializedName

serializedName: string = "ClusterVersion"

type

type: object

className

className: string = "ClusterVersion"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

version

version: object

serializedName

serializedName: string = "Version"

type

type: object

name

name: "String" = "String"

Const CodePackageEntryPoint

CodePackageEntryPoint: object

Information about setup or main entry point of a code package deployed on a Service Fabric node.

Optional codePackageEntryPointStatistics

codePackageEntryPointStatistics: CodePackageEntryPointStatistics

Statistics about setup or main entry point of a code package deployed on a Service Fabric node.

Optional entryPointLocation

entryPointLocation: undefined | string

The location of entry point executable on the node.

Optional instanceId

instanceId: undefined | string

The instance ID for current running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance id will change.

Optional nextActivationTime

nextActivationTime: Date

The time (in UTC) when the entry point executable will be run next.

Optional processId

processId: undefined | string

The process ID of the entry point.

Optional runAsUserName

runAsUserName: undefined | string

The user name under which entry point executable is run on the node.

Optional status

Specifies the status of the code package entry point deployed on a Service Fabric node. Possible values include: 'Invalid', 'Pending', 'Starting', 'Started', 'Stopping', 'Stopped'

serializedName

serializedName: string = "CodePackageEntryPoint"

type

type: object

className

className: string = "CodePackageEntryPoint"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

codePackageEntryPointStatistics

codePackageEntryPointStatistics: object

serializedName

serializedName: string = "CodePackageEntryPointStatistics"

type

type: object

className

className: string = "CodePackageEntryPointStatistics"

name

name: "Composite" = "Composite"

entryPointLocation

entryPointLocation: object

serializedName

serializedName: string = "EntryPointLocation"

type

type: object

name

name: "String" = "String"

instanceId

instanceId: object

serializedName

serializedName: string = "InstanceId"

type

type: object

name

name: "String" = "String"

nextActivationTime

nextActivationTime: object

serializedName

serializedName: string = "NextActivationTime"

type

type: object

name

name: "DateTime" = "DateTime"

processId

processId: object

serializedName

serializedName: string = "ProcessId"

type

type: object

name

name: "String" = "String"

runAsUserName

runAsUserName: object

serializedName

serializedName: string = "RunAsUserName"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "Status"

type

type: object

name

name: "String" = "String"

Const CodePackageEntryPointStatistics

CodePackageEntryPointStatistics: object

Statistics about setup or main entry point of a code package deployed on a Service Fabric node.

Optional activationCount

activationCount: undefined | string

Number of times the entry point has run.

Optional activationFailureCount

activationFailureCount: undefined | string

Number of times the entry point failed to run.

Optional continuousActivationFailureCount

continuousActivationFailureCount: undefined | string

Number of times the entry point continuously failed to run.

Optional continuousExitFailureCount

continuousExitFailureCount: undefined | string

Number of times the entry point continuously failed to exit gracefully.

Optional exitCount

exitCount: undefined | string

Number of times the entry point finished running.

Optional exitFailureCount

exitFailureCount: undefined | string

Number of times the entry point failed to exit gracefully.

Optional lastActivationTime

lastActivationTime: Date

The last time (in UTC) when Service Fabric attempted to run the entry point.

Optional lastExitCode

lastExitCode: undefined | string

The last exit code of the entry point.

Optional lastExitTime

lastExitTime: Date

The last time (in UTC) when the entry point finished running.

Optional lastSuccessfulActivationTime

lastSuccessfulActivationTime: Date

The last time (in UTC) when the entry point ran successfully.

Optional lastSuccessfulExitTime

lastSuccessfulExitTime: Date

The last time (in UTC) when the entry point finished running gracefully.

serializedName

serializedName: string = "CodePackageEntryPointStatistics"

type

type: object

className

className: string = "CodePackageEntryPointStatistics"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

activationCount

activationCount: object

serializedName

serializedName: string = "ActivationCount"

type

type: object

name

name: "String" = "String"

activationFailureCount

activationFailureCount: object

serializedName

serializedName: string = "ActivationFailureCount"

type

type: object

name

name: "String" = "String"

continuousActivationFailureCount

continuousActivationFailureCount: object

serializedName

serializedName: string = "ContinuousActivationFailureCount"

type

type: object

name

name: "String" = "String"

continuousExitFailureCount

continuousExitFailureCount: object

serializedName

serializedName: string = "ContinuousExitFailureCount"

type

type: object

name

name: "String" = "String"

exitCount

exitCount: object

serializedName

serializedName: string = "ExitCount"

type

type: object

name

name: "String" = "String"

exitFailureCount

exitFailureCount: object

serializedName

serializedName: string = "ExitFailureCount"

type

type: object

name

name: "String" = "String"

lastActivationTime

lastActivationTime: object

serializedName

serializedName: string = "LastActivationTime"

type

type: object

name

name: "DateTime" = "DateTime"

lastExitCode

lastExitCode: object

serializedName

serializedName: string = "LastExitCode"

type

type: object

name

name: "String" = "String"

lastExitTime

lastExitTime: object

serializedName

serializedName: string = "LastExitTime"

type

type: object

name

name: "DateTime" = "DateTime"

lastSuccessfulActivationTime

lastSuccessfulActivationTime: object

serializedName

serializedName: string = "LastSuccessfulActivationTime"

type

type: object

name

name: "DateTime" = "DateTime"

lastSuccessfulExitTime

lastSuccessfulExitTime: object

serializedName

serializedName: string = "LastSuccessfulExitTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const ComposeDeploymentStatusInfo

ComposeDeploymentStatusInfo: object

Information about a Service Fabric compose deployment.

Optional applicationName

applicationName: undefined | string

The name of the application, including the 'fabric:' URI scheme.

Optional name

name: undefined | string

The name of the deployment.

Optional status

The status of the compose deployment. Possible values include: 'Invalid', 'Provisioning', 'Creating', 'Ready', 'Unprovisioning', 'Deleting', 'Failed', 'Upgrading'

Optional statusDetails

statusDetails: undefined | string

The status details of compose deployment including failure message.

serializedName

serializedName: string = "ComposeDeploymentStatusInfo"

type

type: object

className

className: string = "ComposeDeploymentStatusInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationName

applicationName: object

serializedName

serializedName: string = "ApplicationName"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "Status"

type

type: object

name

name: "String" = "String"

statusDetails

statusDetails: object

serializedName

serializedName: string = "StatusDetails"

type

type: object

name

name: "String" = "String"

Const ComposeDeploymentUpgradeDescription

ComposeDeploymentUpgradeDescription: object

Describes the parameters for a compose deployment upgrade.

Optional applicationHealthPolicy

applicationHealthPolicy: ApplicationHealthPolicy

Defines a health policy used to evaluate the health of an application or one of its children entities.

composeFileContent

composeFileContent: string

The content of the compose file that describes the deployment to create.

deploymentName

deploymentName: string

The name of the deployment.

Optional forceRestart

forceRestart: undefined | false | true

If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).

Optional monitoringPolicy

monitoringPolicy: MonitoringPolicyDescription

Describes the parameters for monitoring an upgrade in Monitored mode.

Optional registryCredential

registryCredential: RegistryCredential

Credential information to connect to container registry.

Optional rollingUpgradeMode

rollingUpgradeMode: UpgradeMode

The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Default value: 'UnmonitoredAuto'.

upgradeKind

upgradeKind: UpgradeKind

The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling'. Default value: 'Rolling'.

Optional upgradeReplicaSetCheckTimeoutInSeconds

upgradeReplicaSetCheckTimeoutInSeconds: undefined | number

The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).

serializedName

serializedName: string = "ComposeDeploymentUpgradeDescription"

type

type: object

className

className: string = "ComposeDeploymentUpgradeDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationHealthPolicy

applicationHealthPolicy: object

serializedName

serializedName: string = "ApplicationHealthPolicy"

type

type: object

className

className: string = "ApplicationHealthPolicy"

name

name: "Composite" = "Composite"

composeFileContent

composeFileContent: object

required

required: true = true

serializedName

serializedName: string = "ComposeFileContent"

type

type: object

name

name: "String" = "String"

deploymentName

deploymentName: object

required

required: true = true

serializedName

serializedName: string = "DeploymentName"

type

type: object

name

name: "String" = "String"

forceRestart

forceRestart: object

serializedName

serializedName: string = "ForceRestart"

type

type: object

name

name: "Boolean" = "Boolean"

monitoringPolicy

monitoringPolicy: object

serializedName

serializedName: string = "MonitoringPolicy"

type

type: object

className

className: string = "MonitoringPolicyDescription"

name

name: "Composite" = "Composite"

registryCredential

registryCredential: object

serializedName

serializedName: string = "RegistryCredential"

type

type: object

className

className: string = "RegistryCredential"

name

name: "Composite" = "Composite"

rollingUpgradeMode

rollingUpgradeMode: object

defaultValue

defaultValue: string = "UnmonitoredAuto"

serializedName

serializedName: string = "RollingUpgradeMode"

type

type: object

name

name: "String" = "String"

upgradeKind

upgradeKind: object

defaultValue

defaultValue: string = "Rolling"

required

required: true = true

serializedName

serializedName: string = "UpgradeKind"

type

type: object

name

name: "String" = "String"

upgradeReplicaSetCheckTimeoutInSeconds

upgradeReplicaSetCheckTimeoutInSeconds: object

serializedName

serializedName: string = "UpgradeReplicaSetCheckTimeoutInSeconds"

type

type: object

name

name: "Number" = "Number"

Const ComposeDeploymentUpgradeProgressInfo

ComposeDeploymentUpgradeProgressInfo: object

Describes the parameters for a compose deployment upgrade.

Optional applicationHealthPolicy

applicationHealthPolicy: ApplicationHealthPolicy

Defines a health policy used to evaluate the health of an application or one of its children entities.

Optional applicationName

applicationName: undefined | string

The name of the target application, including the 'fabric:' URI scheme.

Optional applicationUnhealthyEvaluations

applicationUnhealthyEvaluations: HealthEvaluationWrapper[]

List of health evaluations that resulted in the current aggregated health state.

Optional applicationUpgradeStatusDetails

applicationUpgradeStatusDetails: undefined | string

Additional details of application upgrade including failure message.

Optional currentUpgradeDomainDuration

currentUpgradeDomainDuration: undefined | string

The estimated amount of time spent processing current Upgrade Domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

Optional currentUpgradeDomainProgress

currentUpgradeDomainProgress: CurrentUpgradeDomainProgressInfo

Information about the current in-progress upgrade domain.

Optional deploymentName

deploymentName: undefined | string

The name of the target deployment.

Optional failureReason

failureReason: FailureReason

The cause of an upgrade failure that resulted in FailureAction being executed. Possible values include: 'None', 'Interrupted', 'HealthCheck', 'UpgradeDomainTimeout', 'OverallUpgradeTimeout'

Optional failureTimestampUtc

failureTimestampUtc: undefined | string

The estimated UTC datetime when the upgrade failed and FailureAction was executed.

Optional forceRestart

forceRestart: undefined | false | true

If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).

Optional monitoringPolicy

monitoringPolicy: MonitoringPolicyDescription

Describes the parameters for monitoring an upgrade in Monitored mode.

Optional rollingUpgradeMode

rollingUpgradeMode: UpgradeMode

The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Default value: 'UnmonitoredAuto'.

Optional startTimestampUtc

startTimestampUtc: undefined | string

The estimated UTC datetime when the upgrade started.

Optional targetApplicationTypeVersion

targetApplicationTypeVersion: undefined | string

The target application type version (found in the application manifest) for the application upgrade.

Optional upgradeDomainProgressAtFailure

upgradeDomainProgressAtFailure: FailureUpgradeDomainProgressInfo

Information about the upgrade domain progress at the time of upgrade failure.

Optional upgradeDuration

upgradeDuration: undefined | string

The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

Optional upgradeKind

upgradeKind: UpgradeKind

The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling'. Default value: 'Rolling'.

Optional upgradeReplicaSetCheckTimeoutInSeconds

upgradeReplicaSetCheckTimeoutInSeconds: undefined | number

The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).

Optional upgradeState

The state of the compose deployment upgrade. Possible values include: 'Invalid', 'ProvisioningTarget', 'RollingForwardInProgress', 'RollingForwardPending', 'UnprovisioningCurrent', 'RollingForwardCompleted', 'RollingBackInProgress', 'UnprovisioningTarget', 'RollingBackCompleted', 'Failed'

Optional upgradeStatusDetails

upgradeStatusDetails: undefined | string

Additional detailed information about the status of the pending upgrade.

serializedName

serializedName: string = "ComposeDeploymentUpgradeProgressInfo"

type

type: object

className

className: string = "ComposeDeploymentUpgradeProgressInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationHealthPolicy

applicationHealthPolicy: object

serializedName

serializedName: string = "ApplicationHealthPolicy"

type

type: object

className

className: string = "ApplicationHealthPolicy"

name

name: "Composite" = "Composite"

applicationName

applicationName: object

serializedName

serializedName: string = "ApplicationName"

type

type: object

name

name: "String" = "String"

applicationUnhealthyEvaluations

applicationUnhealthyEvaluations: object

serializedName

serializedName: string = "ApplicationUnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

applicationUpgradeStatusDetails

applicationUpgradeStatusDetails: object

serializedName

serializedName: string = "ApplicationUpgradeStatusDetails"

type

type: object

name

name: "String" = "String"

currentUpgradeDomainDuration

currentUpgradeDomainDuration: object

serializedName

serializedName: string = "CurrentUpgradeDomainDuration"

type

type: object

name

name: "String" = "String"

currentUpgradeDomainProgress

currentUpgradeDomainProgress: object

serializedName

serializedName: string = "CurrentUpgradeDomainProgress"

type

type: object

className

className: string = "CurrentUpgradeDomainProgressInfo"

name

name: "Composite" = "Composite"

deploymentName

deploymentName: object

serializedName

serializedName: string = "DeploymentName"

type

type: object

name

name: "String" = "String"

failureReason

failureReason: object

serializedName

serializedName: string = "FailureReason"

type

type: object

name

name: "String" = "String"

failureTimestampUtc

failureTimestampUtc: object

serializedName

serializedName: string = "FailureTimestampUtc"

type

type: object

name

name: "String" = "String"

forceRestart

forceRestart: object

serializedName

serializedName: string = "ForceRestart"

type

type: object

name

name: "Boolean" = "Boolean"

monitoringPolicy

monitoringPolicy: object

serializedName

serializedName: string = "MonitoringPolicy"

type

type: object

className

className: string = "MonitoringPolicyDescription"

name

name: "Composite" = "Composite"

rollingUpgradeMode

rollingUpgradeMode: object

defaultValue

defaultValue: string = "UnmonitoredAuto"

serializedName

serializedName: string = "RollingUpgradeMode"

type

type: object

name

name: "String" = "String"

startTimestampUtc

startTimestampUtc: object

serializedName

serializedName: string = "StartTimestampUtc"

type

type: object

name

name: "String" = "String"

targetApplicationTypeVersion

targetApplicationTypeVersion: object

serializedName

serializedName: string = "TargetApplicationTypeVersion"

type

type: object

name

name: "String" = "String"

upgradeDomainProgressAtFailure

upgradeDomainProgressAtFailure: object

serializedName

serializedName: string = "UpgradeDomainProgressAtFailure"

type

type: object

className

className: string = "FailureUpgradeDomainProgressInfo"

name

name: "Composite" = "Composite"

upgradeDuration

upgradeDuration: object

serializedName

serializedName: string = "UpgradeDuration"

type

type: object

name

name: "String" = "String"

upgradeKind

upgradeKind: object

defaultValue

defaultValue: string = "Rolling"

serializedName

serializedName: string = "UpgradeKind"

type

type: object

name

name: "String" = "String"

upgradeReplicaSetCheckTimeoutInSeconds

upgradeReplicaSetCheckTimeoutInSeconds: object

serializedName

serializedName: string = "UpgradeReplicaSetCheckTimeoutInSeconds"

type

type: object

name

name: "Number" = "Number"

upgradeState

upgradeState: object

serializedName

serializedName: string = "UpgradeState"

type

type: object

name

name: "String" = "String"

upgradeStatusDetails

upgradeStatusDetails: object

serializedName

serializedName: string = "UpgradeStatusDetails"

type

type: object

name

name: "String" = "String"

Const ContainerApiRequestBody

ContainerApiRequestBody: object

parameters for making container API call.

Optional body

body: undefined | string

HTTP request body of container REST API

Optional contentType

contentType: undefined | string

Content type of container REST API request, defaults to "application/json"

Optional httpVerb

httpVerb: undefined | string

HTTP verb of container REST API, defaults to "GET"

uriPath

uriPath: string

URI path of container REST API

serializedName

serializedName: string = "ContainerApiRequestBody"

type

type: object

className

className: string = "ContainerApiRequestBody"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

body

body: object

serializedName

serializedName: string = "Body"

type

type: object

name

name: "String" = "String"

contentType

contentType: object

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: "String" = "String"

httpVerb

httpVerb: object

serializedName

serializedName: string = "HttpVerb"

type

type: object

name

name: "String" = "String"

uriPath

uriPath: object

required

required: true = true

serializedName

serializedName: string = "UriPath"

type

type: object

name

name: "String" = "String"

Const ContainerApiResponse

ContainerApiResponse: object

Response body that wraps container API result.

containerApiResult

containerApiResult: ContainerApiResult

Container API result.

serializedName

serializedName: string = "ContainerApiResponse"

type

type: object

className

className: string = "ContainerApiResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerApiResult

containerApiResult: object

required

required: true = true

serializedName

serializedName: string = "ContainerApiResult"

type

type: object

className

className: string = "ContainerApiResult"

name

name: "Composite" = "Composite"

Const ContainerApiResult

ContainerApiResult: object

Container API result.

Optional body

body: undefined | string

container API result body

Optional contentEncoding

contentEncoding: undefined | string

HTTP content encoding

Optional contentType

contentType: undefined | string

HTTP content type

status

status: number

HTTP status code returned by the target container API

serializedName

serializedName: string = "ContainerApiResult"

type

type: object

className

className: string = "ContainerApiResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

body

body: object

serializedName

serializedName: string = "Body"

type

type: object

name

name: "String" = "String"

contentEncoding

contentEncoding: object

serializedName

serializedName: string = "Content-Encoding"

type

type: object

name

name: "String" = "String"

contentType

contentType: object

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: "String" = "String"

status

status: object

required

required: true = true

serializedName

serializedName: string = "Status"

type

type: object

name

name: "Number" = "Number"

Const ContainerCodePackageProperties

ContainerCodePackageProperties: object

Describes a container and its runtime properties.

Optional commands

commands: string[]

Command array to execute within the container in exec form.

Optional diagnostics

diagnostics: DiagnosticsRef

Reference to sinks in DiagnosticsDescription.

Optional endpoints

endpoints: EndpointProperties[]

The endpoints exposed by this container.

Optional entrypoint

entrypoint: undefined | string

Override for the default entry point in the container.

Optional environmentVariables

environmentVariables: EnvironmentVariable[]

The environment variables to set in this container

image

image: string

The Container image to use.

Optional imageRegistryCredential

imageRegistryCredential: ImageRegistryCredential

Image registry credential.

Optional instanceView

instanceView: ContainerInstanceView

Runtime information of a container instance. NOTE: This property will not be serialized. It can only be populated by the server.

Optional labels

labels: ContainerLabel[]

The labels to set in this container.

name

name: string

The name of the code package.

Optional reliableCollectionsRefs

reliableCollectionsRefs: ReliableCollectionsRef[]

A list of ReliableCollection resources used by this particular code package. Please refer to ReliableCollectionsRef for more details.

resources

The resources required by this container.

Optional settings

settings: Setting[]

The settings to set in this container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\secrets". The path for Linux container is "/var/secrets".

Optional volumeRefs

volumeRefs: VolumeReference[]

Volumes to be attached to the container. The lifetime of these volumes is independent of the application's lifetime.

Optional volumes

Volumes to be attached to the container. The lifetime of these volumes is scoped to the application's lifetime.

serializedName

serializedName: string = "ContainerCodePackageProperties"

type

type: object

className

className: string = "ContainerCodePackageProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

commands

commands: object

serializedName

serializedName: string = "commands"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

diagnostics

diagnostics: object

serializedName

serializedName: string = "diagnostics"

type

type: object

className

className: string = "DiagnosticsRef"

name

name: "Composite" = "Composite"

endpoints

endpoints: object

serializedName

serializedName: string = "endpoints"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EndpointProperties"

name

name: "Composite" = "Composite"

entrypoint

entrypoint: object

serializedName

serializedName: string = "entrypoint"

type

type: object

name

name: "String" = "String"

environmentVariables

environmentVariables: object

serializedName

serializedName: string = "environmentVariables"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EnvironmentVariable"

name

name: "Composite" = "Composite"

image

image: object

required

required: true = true

serializedName

serializedName: string = "image"

type

type: object

name

name: "String" = "String"

imageRegistryCredential

imageRegistryCredential: object

serializedName

serializedName: string = "imageRegistryCredential"

type

type: object

className

className: string = "ImageRegistryCredential"

name

name: "Composite" = "Composite"

instanceView

instanceView: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "instanceView"

type

type: object

className

className: string = "ContainerInstanceView"

name

name: "Composite" = "Composite"

labels

labels: object

serializedName

serializedName: string = "labels"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ContainerLabel"

name

name: "Composite" = "Composite"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

reliableCollectionsRefs

reliableCollectionsRefs: object

serializedName

serializedName: string = "reliableCollectionsRefs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ReliableCollectionsRef"

name

name: "Composite" = "Composite"

resources

resources: object

required

required: true = true

serializedName

serializedName: string = "resources"

type

type: object

className

className: string = "ResourceRequirements"

name

name: "Composite" = "Composite"

settings

settings: object

serializedName

serializedName: string = "settings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Setting"

name

name: "Composite" = "Composite"

volumeRefs

volumeRefs: object

serializedName

serializedName: string = "volumeRefs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VolumeReference"

name

name: "Composite" = "Composite"

volumes

volumes: object

serializedName

serializedName: string = "volumes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationScopedVolume"

name

name: "Composite" = "Composite"

Const ContainerEvent

ContainerEvent: object

A container event.

Optional count

count: undefined | number

The count of the event.

Optional firstTimestamp

firstTimestamp: undefined | string

Date/time of the first event.

Optional lastTimestamp

lastTimestamp: undefined | string

Date/time of the last event.

Optional message

message: undefined | string

The event message

Optional name

name: undefined | string

The name of the container event.

serializedName

serializedName: string = "ContainerEvent"

Optional type

type: object

The event type.

className

className: string = "ContainerEvent"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

count

count: object

serializedName

serializedName: string = "count"

type

type: object

name

name: "Number" = "Number"

firstTimestamp

firstTimestamp: object

serializedName

serializedName: string = "firstTimestamp"

type

type: object

name

name: "String" = "String"

lastTimestamp

lastTimestamp: object

serializedName

serializedName: string = "lastTimestamp"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ContainerInstanceEvent

ContainerInstanceEvent: object

Represents the base for all Container Events.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ContainerInstanceEvent"

Polymorphic Discriminator

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ContainerInstanceEvent"

type

type: object

className

className: string = "ContainerInstanceEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

Const ContainerInstanceView

ContainerInstanceView: object

Runtime information of a container instance.

Optional currentState

currentState: ContainerState

Current container instance state.

Optional events

events: ContainerEvent[]

The events of this container instance.

Optional previousState

previousState: ContainerState

Previous container instance state.

Optional restartCount

restartCount: undefined | number

The number of times the container has been restarted.

serializedName

serializedName: string = "ContainerInstanceView"

type

type: object

className

className: string = "ContainerInstanceView"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

currentState

currentState: object

serializedName

serializedName: string = "currentState"

type

type: object

className

className: string = "ContainerState"

name

name: "Composite" = "Composite"

events

events: object

serializedName

serializedName: string = "events"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ContainerEvent"

name

name: "Composite" = "Composite"

previousState

previousState: object

serializedName

serializedName: string = "previousState"

type

type: object

className

className: string = "ContainerState"

name

name: "Composite" = "Composite"

restartCount

restartCount: object

serializedName

serializedName: string = "restartCount"

type

type: object

name

name: "Number" = "Number"

Const ContainerLabel

ContainerLabel: object

Describes a container label.

name

name: string

The name of the container label.

value

value: string

The value of the container label.

serializedName

serializedName: string = "ContainerLabel"

type

type: object

className

className: string = "ContainerLabel"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const ContainerLogs

ContainerLogs: object

Container logs.

Optional content

content: undefined | string

Container logs.

serializedName

serializedName: string = "ContainerLogs"

type

type: object

className

className: string = "ContainerLogs"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

content

content: object

serializedName

serializedName: string = "Content"

type

type: object

name

name: "String" = "String"

Const ContainerState

ContainerState: object

The container state.

Optional detailStatus

detailStatus: undefined | string

Human-readable status of this state.

Optional exitCode

exitCode: undefined | string

The container exit code.

Optional finishTime

finishTime: Date

Date/time when the container state finished.

Optional startTime

startTime: Date

Date/time when the container state started.

Optional state

state: undefined | string

The state of this container

serializedName

serializedName: string = "ContainerState"

type

type: object

className

className: string = "ContainerState"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

detailStatus

detailStatus: object

serializedName

serializedName: string = "detailStatus"

type

type: object

name

name: "String" = "String"

exitCode

exitCode: object

serializedName

serializedName: string = "exitCode"

type

type: object

name

name: "String" = "String"

finishTime

finishTime: object

serializedName

serializedName: string = "finishTime"

type

type: object

name

name: "DateTime" = "DateTime"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

name

name: "String" = "String"

Const CreateComposeDeploymentDescription

CreateComposeDeploymentDescription: object

Defines description for creating a Service Fabric compose deployment.

composeFileContent

composeFileContent: string

The content of the compose file that describes the deployment to create.

deploymentName

deploymentName: string

The name of the deployment.

Optional registryCredential

registryCredential: RegistryCredential

Credential information to connect to container registry.

serializedName

serializedName: string = "CreateComposeDeploymentDescription"

type

type: object

className

className: string = "CreateComposeDeploymentDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

composeFileContent

composeFileContent: object

required

required: true = true

serializedName

serializedName: string = "ComposeFileContent"

type

type: object

name

name: "String" = "String"

deploymentName

deploymentName: object

required

required: true = true

serializedName

serializedName: string = "DeploymentName"

type

type: object

name

name: "String" = "String"

registryCredential

registryCredential: object

serializedName

serializedName: string = "RegistryCredential"

type

type: object

className

className: string = "RegistryCredential"

name

name: "Composite" = "Composite"

Const CurrentUpgradeDomainProgressInfo

CurrentUpgradeDomainProgressInfo: object

Information about the current in-progress upgrade domain.

Optional domainName

domainName: undefined | string

The name of the upgrade domain

Optional nodeUpgradeProgressList

nodeUpgradeProgressList: NodeUpgradeProgressInfo[]

List of upgrading nodes and their statuses

serializedName

serializedName: string = "CurrentUpgradeDomainProgressInfo"

type

type: object

className

className: string = "CurrentUpgradeDomainProgressInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

domainName

domainName: object

serializedName

serializedName: string = "DomainName"

type

type: object

name

name: "String" = "String"

nodeUpgradeProgressList

nodeUpgradeProgressList: object

serializedName

serializedName: string = "NodeUpgradeProgressList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NodeUpgradeProgressInfo"

name

name: "Composite" = "Composite"

Const DeactivationIntentDescription

DeactivationIntentDescription: object

Describes the intent or reason for deactivating the node.

Optional deactivationIntent

deactivationIntent: DeactivationIntent

Describes the intent or reason for deactivating the node. The possible values are following. Possible values include: 'Pause', 'Restart', 'RemoveData'

serializedName

serializedName: string = "DeactivationIntentDescription"

type

type: object

className

className: string = "DeactivationIntentDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

deactivationIntent

deactivationIntent: object

serializedName

serializedName: string = "DeactivationIntent"

type

type: object

name

name: "String" = "String"

Const DeletePropertyBatchOperation

DeletePropertyBatchOperation: object

Represents a PropertyBatchOperation that deletes a specified property if it exists. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.

kind

kind: "Delete"

Polymorphic Discriminator

propertyName

propertyName: string

The name of the Service Fabric property.

serializedName

serializedName: string = "Delete"

type

type: object

className

className: string = "DeletePropertyBatchOperation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PropertyBatchOperation.type.polymorphicDiscriminator

uberParent

uberParent: string = "PropertyBatchOperation"

modelProperties

modelProperties: object

Const DeltaNodesCheckHealthEvaluation

DeltaNodesCheckHealthEvaluation: object

Represents health evaluation for delta nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned during cluster upgrade when the aggregated health state of the cluster is Warning or Error.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional baselineErrorCount

baselineErrorCount: undefined | number

Number of nodes with aggregated heath state Error in the health store at the beginning of the cluster upgrade.

Optional baselineTotalCount

baselineTotalCount: undefined | number

Total number of nodes in the health store at the beginning of the cluster upgrade.

Optional description

description: undefined | string

Description of the health evaluation, which represents a summary of the evaluation process.

kind

kind: "DeltaNodesCheck"

Polymorphic Discriminator

Optional maxPercentDeltaUnhealthyNodes

maxPercentDeltaUnhealthyNodes: undefined | number

Maximum allowed percentage of delta unhealthy nodes from the ClusterUpgradeHealthPolicy.

Optional totalCount

totalCount: undefined | number

Total number of nodes in the health store.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health.

serializedName

serializedName: string = "DeltaNodesCheck"

type

type: object

className

className: string = "DeltaNodesCheckHealthEvaluation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = HealthEvaluation.type.polymorphicDiscriminator

uberParent

uberParent: string = "HealthEvaluation"

modelProperties

modelProperties: object

baselineErrorCount

baselineErrorCount: object

serializedName

serializedName: string = "BaselineErrorCount"

type

type: object

name

name: "Number" = "Number"

baselineTotalCount

baselineTotalCount: object

serializedName

serializedName: string = "BaselineTotalCount"

type

type: object

name

name: "Number" = "Number"

maxPercentDeltaUnhealthyNodes

maxPercentDeltaUnhealthyNodes: object

serializedName

serializedName: string = "MaxPercentDeltaUnhealthyNodes"

type

type: object

name

name: "Number" = "Number"

totalCount

totalCount: object

serializedName

serializedName: string = "TotalCount"

type

type: object

name

name: "Number" = "Number"

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

Const DeployServicePackageToNodeDescription

DeployServicePackageToNodeDescription: object

Defines description for downloading packages associated with a service manifest to image cache on a Service Fabric node.

applicationTypeName

applicationTypeName: string

The application type name as defined in the application manifest.

applicationTypeVersion

applicationTypeVersion: string

The version of the application type as defined in the application manifest.

nodeName

nodeName: string

The name of a Service Fabric node.

Optional packageSharingPolicy

packageSharingPolicy: PackageSharingPolicyInfo[]

List of package sharing policy information.

serviceManifestName

serviceManifestName: string

The name of service manifest whose packages need to be downloaded.

serializedName

serializedName: string = "DeployServicePackageToNodeDescription"

type

type: object

className

className: string = "DeployServicePackageToNodeDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationTypeName

applicationTypeName: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeName"

type

type: object

name

name: "String" = "String"

applicationTypeVersion

applicationTypeVersion: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeVersion"

type

type: object

name

name: "String" = "String"

nodeName

nodeName: object

required

required: true = true

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

packageSharingPolicy

packageSharingPolicy: object

serializedName

serializedName: string = "PackageSharingPolicy"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PackageSharingPolicyInfo"

name

name: "Composite" = "Composite"

serviceManifestName

serviceManifestName: object

required

required: true = true

serializedName

serializedName: string = "ServiceManifestName"

type

type: object

name

name: "String" = "String"

Const DeployedApplicationHealth

DeployedApplicationHealth: object

Information about the health of an application deployed on a Service Fabric node.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional deployedServicePackageHealthStates

deployedServicePackageHealthStates: DeployedServicePackageHealthState[]

Deployed service package health states for the current deployed application as found in the health store.

Optional healthEvents

healthEvents: HealthEvent[]

The list of health events reported on the entity.

Optional healthStatistics

healthStatistics: HealthStatistics

Shows the health statistics for all children types of the queried entity.

Optional name

name: undefined | string

Name of the application deployed on the node whose health information is described by this object.

Optional nodeName

nodeName: undefined | string

Name of the node where this application is deployed.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.

serializedName

serializedName: string = "DeployedApplicationHealth"

type

type: object

className

className: string = "DeployedApplicationHealth"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

deployedServicePackageHealthStates

deployedServicePackageHealthStates: object

serializedName

serializedName: string = "DeployedServicePackageHealthStates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DeployedServicePackageHealthState"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

nodeName

nodeName: object

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

Const DeployedApplicationHealthEvaluation

DeployedApplicationHealthEvaluation: object

Represents health evaluation for a deployed application, containing information about the data and the algorithm used by the health store to evaluate health.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional applicationName

applicationName: undefined | string

The name of the application, including the 'fabric:' URI scheme.

Optional description

description: undefined | string

Description of the health evaluation, which represents a summary of the evaluation process.

kind

kind: "DeployedApplication"

Polymorphic Discriminator

Optional nodeName

nodeName: undefined | string

Name of the node where the application is deployed to.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

List of unhealthy evaluations that led to the current aggregated health state of the deployed application. The types of the unhealthy evaluations can be DeployedServicePackagesHealthEvaluation or EventHealthEvaluation.

serializedName

serializedName: string = "DeployedApplication"

type

type: object

className

className: string = "DeployedApplicationHealthEvaluation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = HealthEvaluation.type.polymorphicDiscriminator

uberParent

uberParent: string = "HealthEvaluation"

modelProperties

modelProperties: object

applicationName

applicationName: object

serializedName

serializedName: string = "ApplicationName"

type

type: object

name

name: "String" = "String"

nodeName

nodeName: object

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

Const DeployedApplicationHealthReportExpiredEvent

DeployedApplicationHealthReportExpiredEvent: object

Deployed Application Health Report Expired event.

applicationId

applicationId: string

The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

applicationInstanceId

applicationInstanceId: number

Id of Application instance.

Optional category

category: undefined | string

The category of event.

description

description: string

Description of report.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

healthState

healthState: string

Describes the property health state.

kind

kind: "DeployedApplicationHealthReportExpired"

Polymorphic Discriminator

nodeName

nodeName: string

The name of a Service Fabric node.

property

property: string

Describes the property.

removeWhenExpired

removeWhenExpired: boolean

Indicates the removal when it expires.

sequenceNumber

sequenceNumber: number

Sequence number of report.

sourceId

sourceId: string

Id of report source.

sourceUtcTimestamp

sourceUtcTimestamp: Date

Source time.

timeStamp

timeStamp: Date

The time event was logged.

timeToLiveMs

timeToLiveMs: number

Time to live in milli-seconds.

serializedName

serializedName: string = "DeployedApplicationHealthReportExpired"

type

type: object

className

className: string = "DeployedApplicationHealthReportExpiredEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

applicationInstanceId

applicationInstanceId: object

required

required: true = true

serializedName

serializedName: string = "ApplicationInstanceId"

type

type: object

name

name: "Number" = "Number"

description

description: object

required

required: true = true

serializedName

serializedName: string = "Description"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

required

required: true = true

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

nodeName

nodeName: object

required

required: true = true

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

property

property: object

required

required: true = true

serializedName

serializedName: string = "Property"

type

type: object

name

name: "String" = "String"

removeWhenExpired

removeWhenExpired: object

required

required: true = true

serializedName

serializedName: string = "RemoveWhenExpired"

type

type: object

name

name: "Boolean" = "Boolean"

sequenceNumber

sequenceNumber: object

required

required: true = true

serializedName

serializedName: string = "SequenceNumber"

type

type: object

name

name: "Number" = "Number"

sourceId

sourceId: object

required

required: true = true

serializedName

serializedName: string = "SourceId"

type

type: object

name

name: "String" = "String"

sourceUtcTimestamp

sourceUtcTimestamp: object

required

required: true = true

serializedName

serializedName: string = "SourceUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

timeToLiveMs

timeToLiveMs: object

required

required: true = true

serializedName

serializedName: string = "TimeToLiveMs"

type

type: object

name

name: "Number" = "Number"

Const DeployedApplicationHealthState

DeployedApplicationHealthState: object

Represents the health state of a deployed application, which contains the entity identifier and the aggregated health state.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional applicationName

applicationName: undefined | string

The name of the application, including the 'fabric:' URI scheme.

Optional nodeName

nodeName: undefined | string

Name of the node on which the service package is deployed.

serializedName

serializedName: string = "DeployedApplicationHealthState"

type

type: object

className

className: string = "DeployedApplicationHealthState"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationName

applicationName: object

serializedName

serializedName: string = "ApplicationName"

type

type: object

name

name: "String" = "String"

nodeName

nodeName: object

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

Const DeployedApplicationHealthStateChunk

DeployedApplicationHealthStateChunk: object

Represents the health state chunk of a deployed application, which contains the node where the application is deployed, the aggregated health state and any deployed service packages that respect the chunk query description filters.

Optional deployedServicePackageHealthStateChunks

deployedServicePackageHealthStateChunks: DeployedServicePackageHealthStateChunkList

The list of deployed service package health state chunks belonging to the deployed application that respect the filters in the cluster health chunk query description.

Optional healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional nodeName

nodeName: undefined | string

The name of node where the application is deployed.

serializedName

serializedName: string = "DeployedApplicationHealthStateChunk"

type

type: object

className

className: string = "DeployedApplicationHealthStateChunk"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

deployedServicePackageHealthStateChunks

deployedServicePackageHealthStateChunks: object

serializedName

serializedName: string = "DeployedServicePackageHealthStateChunks"

type

type: object

className

className: string = "DeployedServicePackageHealthStateChunkList"

name

name: "Composite" = "Composite"

nodeName

nodeName: object

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

Const DeployedApplicationHealthStateChunkList

DeployedApplicationHealthStateChunkList: object

The list of deployed application health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.

Optional items

The list of deployed application health state chunks that respect the input filters in the chunk query.

serializedName

serializedName: string = "DeployedApplicationHealthStateChunkList"

type

type: object

className

className: string = "DeployedApplicationHealthStateChunkList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DeployedApplicationHealthStateChunk"

name

name: "Composite" = "Composite"

Const DeployedApplicationHealthStateFilter

DeployedApplicationHealthStateFilter: object

Defines matching criteria to determine whether a deployed application should be included as a child of an application in the cluster health chunk. The deployed applications are only returned if the parent application matches a filter specified in the cluster health chunk query description. One filter can match zero, one or multiple deployed applications, depending on its properties.

Optional deployedServicePackageFilters

deployedServicePackageFilters: DeployedServicePackageHealthStateFilter[]

Defines a list of filters that specify which deployed service packages to be included in the returned cluster health chunk as children of the parent deployed application. The deployed service packages are returned only if the parent deployed application matches a filter. If the list is empty, no deployed service packages are returned. All the deployed service packages are used to evaluate the parent deployed application aggregated health state, regardless of the input filters. The deployed application filter may specify multiple deployed service package filters. For example, it can specify a filter to return all deployed service packages with health state Error and another filter to always include a deployed service package on a node.

Optional healthStateFilter

healthStateFilter: undefined | number

The filter for the health state of the deployed applications. It allows selecting deployed applications if they match the desired health states. The possible values are integer value of one of the following health states. Only deployed applications that match the filter are returned. All deployed applications are used to evaluate the cluster aggregated health state. If not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching deployed application is returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6, it matches deployed applications with HealthState value of OK (2) and Warning (4).

  • Default - Default value. Matches any HealthState. The value is zero.
  • None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.
  • Ok - Filter that matches input with HealthState value Ok. The value is 2.
  • Warning - Filter that matches input with HealthState value Warning. The value is 4.
  • Error - Filter that matches input with HealthState value Error. The value is 8.
  • All - Filter that matches input with any HealthState value. The value is 65535. Default value: 0.

Optional nodeNameFilter

nodeNameFilter: undefined | string

The name of the node where the application is deployed in order to match the filter. If specified, the filter is applied only to the application deployed on the specified node. If the application is not deployed on the node with the specified name, no deployed application is returned in the cluster health chunk based on this filter. Otherwise, the deployed application is included in the cluster health chunk if it respects the other filter properties. If not specified, all deployed applications that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.

serializedName

serializedName: string = "DeployedApplicationHealthStateFilter"

type

type: object

className

className: string = "DeployedApplicationHealthStateFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

deployedServicePackageFilters

deployedServicePackageFilters: object

serializedName

serializedName: string = "DeployedServicePackageFilters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DeployedServicePackageHealthStateFilter"

name

name: "Composite" = "Composite"

healthStateFilter

healthStateFilter: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "HealthStateFilter"

type

type: object

name

name: "Number" = "Number"

nodeNameFilter

nodeNameFilter: object

serializedName

serializedName: string = "NodeNameFilter"

type

type: object

name

name: "String" = "String"

Const DeployedApplicationInfo

DeployedApplicationInfo: object

Information about application deployed on the node.

Optional healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional id

id: undefined | string

The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

Optional logDirectory

logDirectory: undefined | string

The log directory of the application on the node. The log directory can be used to store application logs.

Optional name

name: undefined | string

The name of the application, including the 'fabric:' URI scheme.

Optional status

The status of the application deployed on the node. Following are the possible values. Possible values include: 'Invalid', 'Downloading', 'Activating', 'Active', 'Upgrading', 'Deactivating'

Optional tempDirectory

tempDirectory: undefined | string

The temp directory of the application on the node. The code packages belonging to the application are forked with this directory set as their temporary directory.

Optional typeName

typeName: undefined | string

The application type name as defined in the application manifest.

Optional workDirectory

workDirectory: undefined | string

The work directory of the application on the node. The work directory can be used to store application data.

serializedName

serializedName: string = "DeployedApplicationInfo"

type

type: object

className

className: string = "DeployedApplicationInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

healthState

healthState: object

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

id

id: object

serializedName

serializedName: string = "Id"

type

type: object

name

name: "String" = "String"

logDirectory

logDirectory: object

serializedName

serializedName: string = "LogDirectory"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "Status"

type

type: object

name

name: "String" = "String"

tempDirectory

tempDirectory: object

serializedName

serializedName: string = "TempDirectory"

type

type: object

name

name: "String" = "String"

typeName

typeName: object

serializedName

serializedName: string = "TypeName"

type

type: object

name

name: "String" = "String"

workDirectory

workDirectory: object

serializedName

serializedName: string = "WorkDirectory"

type

type: object

name

name: "String" = "String"

Const DeployedApplicationNewHealthReportEvent

DeployedApplicationNewHealthReportEvent: object

Deployed Application Health Report Created event.

applicationId

applicationId: string

The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

applicationInstanceId

applicationInstanceId: number

Id of Application instance.

Optional category

category: undefined | string

The category of event.

description

description: string

Description of report.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

healthState

healthState: string

Describes the property health state.

kind

kind: "DeployedApplicationNewHealthReport"

Polymorphic Discriminator

nodeName

nodeName: string

The name of a Service Fabric node.

property

property: string

Describes the property.

removeWhenExpired

removeWhenExpired: boolean

Indicates the removal when it expires.

sequenceNumber

sequenceNumber: number

Sequence number of report.

sourceId

sourceId: string

Id of report source.

sourceUtcTimestamp

sourceUtcTimestamp: Date

Source time.

timeStamp

timeStamp: Date

The time event was logged.

timeToLiveMs

timeToLiveMs: number

Time to live in milli-seconds.

serializedName

serializedName: string = "DeployedApplicationNewHealthReport"

type

type: object

className

className: string = "DeployedApplicationNewHealthReportEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

applicationInstanceId

applicationInstanceId: object

required

required: true = true

serializedName

serializedName: string = "ApplicationInstanceId"

type

type: object

name

name: "Number" = "Number"

description

description: object

required

required: true = true

serializedName

serializedName: string = "Description"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

required

required: true = true

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

nodeName

nodeName: object

required

required: true = true

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

property

property: object

required

required: true = true

serializedName

serializedName: string = "Property"

type

type: object

name

name: "String" = "String"

removeWhenExpired

removeWhenExpired: object

required

required: true = true

serializedName

serializedName: string = "RemoveWhenExpired"

type

type: object

name

name: "Boolean" = "Boolean"

sequenceNumber

sequenceNumber: object

required

required: true = true

serializedName

serializedName: string = "SequenceNumber"

type

type: object

name

name: "Number" = "Number"

sourceId

sourceId: object

required

required: true = true

serializedName

serializedName: string = "SourceId"

type

type: object

name

name: "String" = "String"

sourceUtcTimestamp

sourceUtcTimestamp: object

required

required: true = true

serializedName

serializedName: string = "SourceUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

timeToLiveMs

timeToLiveMs: object

required

required: true = true

serializedName

serializedName: string = "TimeToLiveMs"

type

type: object

name

name: "Number" = "Number"

Const DeployedApplicationsHealthEvaluation

DeployedApplicationsHealthEvaluation: object

Represents health evaluation for deployed applications, containing health evaluations for each unhealthy deployed application that impacted current aggregated health state. Can be returned when evaluating application health and the aggregated health state is either Error or Warning.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional description

description: undefined | string

Description of the health evaluation, which represents a summary of the evaluation process.

kind

kind: "DeployedApplications"

Polymorphic Discriminator

Optional maxPercentUnhealthyDeployedApplications

maxPercentUnhealthyDeployedApplications: undefined | number

Maximum allowed percentage of unhealthy deployed applications from the ApplicationHealthPolicy.

Optional totalCount

totalCount: undefined | number

Total number of deployed applications of the application in the health store.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy DeployedApplicationHealthEvaluation that impacted the aggregated health.

serializedName

serializedName: string = "DeployedApplications"

type

type: object

className

className: string = "DeployedApplicationsHealthEvaluation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = HealthEvaluation.type.polymorphicDiscriminator

uberParent

uberParent: string = "HealthEvaluation"

modelProperties

modelProperties: object

maxPercentUnhealthyDeployedApplications

maxPercentUnhealthyDeployedApplications: object

serializedName

serializedName: string = "MaxPercentUnhealthyDeployedApplications"

type

type: object

name

name: "Number" = "Number"

totalCount

totalCount: object

serializedName

serializedName: string = "TotalCount"

type

type: object

name

name: "Number" = "Number"

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

Const DeployedCodePackageInfo

DeployedCodePackageInfo: object

Information about code package deployed on a Service Fabric node.

Optional hostIsolationMode

hostIsolationMode: HostIsolationMode

Specifies the isolation mode of main entry point of a code package when it's host type is ContainerHost. This is specified as part of container host policies in application manifest while importing service manifest. Possible values include: 'None', 'Process', 'HyperV'

Optional hostType

hostType: HostType

Specifies the type of host for main entry point of a code package as specified in service manifest. Possible values include: 'Invalid', 'ExeHost', 'ContainerHost'

Optional mainEntryPoint

mainEntryPoint: CodePackageEntryPoint

Information about setup or main entry point of a code package deployed on a Service Fabric node.

Optional name

name: undefined | string

The name of the code package.

Optional runFrequencyInterval

runFrequencyInterval: undefined | string

The interval at which code package is run. This is used for periodic code package.

Optional serviceManifestName

serviceManifestName: undefined | string

The name of service manifest that specified this code package.

Optional servicePackageActivationId

servicePackageActivationId: undefined | string

The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.

Optional setupEntryPoint

setupEntryPoint: CodePackageEntryPoint

Information about setup or main entry point of a code package deployed on a Service Fabric node.

Optional status

Specifies the status of a deployed application or service package on a Service Fabric node. Possible values include: 'Invalid', 'Downloading', 'Activating', 'Active', 'Upgrading', 'Deactivating'

Optional version

version: undefined | string

The version of the code package specified in service manifest.

serializedName

serializedName: string = "DeployedCodePackageInfo"

type

type: object

className

className: string = "DeployedCodePackageInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

hostIsolationMode

hostIsolationMode: object

serializedName

serializedName: string = "HostIsolationMode"

type

type: object

name

name: "String" = "String"

hostType

hostType: object

serializedName

serializedName: string = "HostType"

type

type: object

name

name: "String" = "String"

mainEntryPoint

mainEntryPoint: object

serializedName

serializedName: string = "MainEntryPoint"

type

type: object

className

className: string = "CodePackageEntryPoint"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

runFrequencyInterval

runFrequencyInterval: object

serializedName

serializedName: string = "RunFrequencyInterval"

type

type: object

name

name: "String" = "String"

serviceManifestName

serviceManifestName: object

serializedName

serializedName: string = "ServiceManifestName"

type

type: object

name

name: "String" = "String"

servicePackageActivationId

servicePackageActivationId: object

serializedName

serializedName: string = "ServicePackageActivationId"

type

type: object

name

name: "String" = "String"

setupEntryPoint

setupEntryPoint: object

serializedName

serializedName: string = "SetupEntryPoint"

type

type: object

className

className: string = "CodePackageEntryPoint"

name

name: "Composite" = "Composite"

status

status: object

serializedName

serializedName: string = "Status"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "Version"

type

type: object

name

name: "String" = "String"

Const DeployedServicePackageHealth

DeployedServicePackageHealth: object

Information about the health of a service package for a specific application deployed on a Service Fabric node.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional applicationName

applicationName: undefined | string

The name of the application, including the 'fabric:' URI scheme.

Optional healthEvents

healthEvents: HealthEvent[]

The list of health events reported on the entity.

Optional healthStatistics

healthStatistics: HealthStatistics

Shows the health statistics for all children types of the queried entity.

Optional nodeName

nodeName: undefined | string

Name of the node where this service package is deployed.

Optional serviceManifestName

serviceManifestName: undefined | string

Name of the service manifest.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.

serializedName

serializedName: string = "DeployedServicePackageHealth"

type

type: object

className

className: string = "DeployedServicePackageHealth"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationName

applicationName: object

serializedName

serializedName: string = "ApplicationName"

type

type: object

name

name: "String" = "String"

nodeName

nodeName: object

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

serviceManifestName

serviceManifestName: object

serializedName

serializedName: string = "ServiceManifestName"

type

type: object

name

name: "String" = "String"

Const DeployedServicePackageHealthEvaluation

DeployedServicePackageHealthEvaluation: object

Represents health evaluation for a deployed service package, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional applicationName

applicationName: undefined | string

The name of the application, including the 'fabric:' URI scheme.

Optional description

description: undefined | string

Description of the health evaluation, which represents a summary of the evaluation process.

kind

kind: "DeployedServicePackage"

Polymorphic Discriminator

Optional nodeName

nodeName: undefined | string

The name of a Service Fabric node.

Optional serviceManifestName

serviceManifestName: undefined | string

The name of the service manifest.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

List of unhealthy evaluations that led to the current aggregated health state. The type of the unhealthy evaluations can be EventHealthEvaluation.

serializedName

serializedName: string = "DeployedServicePackage"

type

type: object

className

className: string = "DeployedServicePackageHealthEvaluation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = HealthEvaluation.type.polymorphicDiscriminator

uberParent

uberParent: string = "HealthEvaluation"

modelProperties

modelProperties: object

applicationName

applicationName: object

serializedName

serializedName: string = "ApplicationName"

type

type: object

name

name: "String" = "String"

nodeName

nodeName: object

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

serviceManifestName

serviceManifestName: object

serializedName

serializedName: string = "ServiceManifestName"

type

type: object

name

name: "String" = "String"

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

Const DeployedServicePackageHealthReportExpiredEvent

DeployedServicePackageHealthReportExpiredEvent: object

Deployed Service Health Report Expired event.

applicationId

applicationId: string

The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

Optional category

category: undefined | string

The category of event.

description

description: string

Description of report.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

healthState

healthState: string

Describes the property health state.

kind

kind: "DeployedServicePackageHealthReportExpired"

Polymorphic Discriminator

nodeName

nodeName: string

The name of a Service Fabric node.

property

property: string

Describes the property.

removeWhenExpired

removeWhenExpired: boolean

Indicates the removal when it expires.

sequenceNumber

sequenceNumber: number

Sequence number of report.

serviceManifest

serviceManifest: string

Service manifest name.

servicePackageActivationId

servicePackageActivationId: string

Id of Service package activation.

servicePackageInstanceId

servicePackageInstanceId: number

Id of Service package instance.

sourceId

sourceId: string

Id of report source.

sourceUtcTimestamp

sourceUtcTimestamp: Date

Source time.

timeStamp

timeStamp: Date

The time event was logged.

timeToLiveMs

timeToLiveMs: number

Time to live in milli-seconds.

serializedName

serializedName: string = "DeployedServicePackageHealthReportExpired"

type

type: object

className

className: string = "DeployedServicePackageHealthReportExpiredEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

description

description: object

required

required: true = true

serializedName

serializedName: string = "Description"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

required

required: true = true

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

nodeName

nodeName: object

required

required: true = true

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

property

property: object

required

required: true = true

serializedName

serializedName: string = "Property"

type

type: object

name

name: "String" = "String"

removeWhenExpired

removeWhenExpired: object

required

required: true = true

serializedName

serializedName: string = "RemoveWhenExpired"

type

type: object

name

name: "Boolean" = "Boolean"

sequenceNumber

sequenceNumber: object

required

required: true = true

serializedName

serializedName: string = "SequenceNumber"

type

type: object

name

name: "Number" = "Number"

serviceManifest

serviceManifest: object

required

required: true = true

serializedName

serializedName: string = "ServiceManifest"

type

type: object

name

name: "String" = "String"

servicePackageActivationId

servicePackageActivationId: object

required

required: true = true

serializedName

serializedName: string = "ServicePackageActivationId"

type

type: object

name

name: "String" = "String"

servicePackageInstanceId

servicePackageInstanceId: object

required

required: true = true

serializedName

serializedName: string = "ServicePackageInstanceId"

type

type: object

name

name: "Number" = "Number"

sourceId

sourceId: object

required

required: true = true

serializedName

serializedName: string = "SourceId"

type

type: object

name

name: "String" = "String"

sourceUtcTimestamp

sourceUtcTimestamp: object

required

required: true = true

serializedName

serializedName: string = "SourceUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

timeToLiveMs

timeToLiveMs: object

required

required: true = true

serializedName

serializedName: string = "TimeToLiveMs"

type

type: object

name

name: "Number" = "Number"

Const DeployedServicePackageHealthState

DeployedServicePackageHealthState: object

Represents the health state of a deployed service package, containing the entity identifier and the aggregated health state.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional applicationName

applicationName: undefined | string

The name of the application, including the 'fabric:' URI scheme.

Optional nodeName

nodeName: undefined | string

Name of the node on which the service package is deployed.

Optional serviceManifestName

serviceManifestName: undefined | string

Name of the manifest describing the service package.

Optional servicePackageActivationId

servicePackageActivationId: undefined | string

The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.

serializedName

serializedName: string = "DeployedServicePackageHealthState"

type

type: object

className

className: string = "DeployedServicePackageHealthState"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationName

applicationName: object

serializedName

serializedName: string = "ApplicationName"

type

type: object

name

name: "String" = "String"

nodeName

nodeName: object

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

serviceManifestName

serviceManifestName: object

serializedName

serializedName: string = "ServiceManifestName"

type

type: object

name

name: "String" = "String"

servicePackageActivationId

servicePackageActivationId: object

serializedName

serializedName: string = "ServicePackageActivationId"

type

type: object

name

name: "String" = "String"

Const DeployedServicePackageHealthStateChunk

DeployedServicePackageHealthStateChunk: object

Represents the health state chunk of a deployed service package, which contains the service manifest name and the service package aggregated health state.

Optional healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional serviceManifestName

serviceManifestName: undefined | string

The name of the service manifest.

Optional servicePackageActivationId

servicePackageActivationId: undefined | string

The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.

serializedName

serializedName: string = "DeployedServicePackageHealthStateChunk"

type

type: object

className

className: string = "DeployedServicePackageHealthStateChunk"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

serviceManifestName

serviceManifestName: object

serializedName

serializedName: string = "ServiceManifestName"

type

type: object

name

name: "String" = "String"

servicePackageActivationId

servicePackageActivationId: object

serializedName

serializedName: string = "ServicePackageActivationId"

type

type: object

name

name: "String" = "String"

Const DeployedServicePackageHealthStateChunkList

DeployedServicePackageHealthStateChunkList: object

The list of deployed service package health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.

Optional items

The list of deployed service package health state chunks that respect the input filters in the chunk query.

serializedName

serializedName: string = "DeployedServicePackageHealthStateChunkList"

type

type: object

className

className: string = "DeployedServicePackageHealthStateChunkList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DeployedServicePackageHealthStateChunk"

name

name: "Composite" = "Composite"

Const DeployedServicePackageHealthStateFilter

DeployedServicePackageHealthStateFilter: object

Defines matching criteria to determine whether a deployed service package should be included as a child of a deployed application in the cluster health chunk. The deployed service packages are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent deployed application and its parent application must be included in the cluster health chunk. One filter can match zero, one or multiple deployed service packages, depending on its properties.

Optional healthStateFilter

healthStateFilter: undefined | number

The filter for the health state of the deployed service packages. It allows selecting deployed service packages if they match the desired health states. The possible values are integer value of one of the following health states. Only deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the parent deployed application aggregated health state. If not specified, default value is None, unless the deployed service package ID is specified. If the filter has default value and deployed service package ID is specified, the matching deployed service package is returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6, it matches deployed service packages with HealthState value of OK (2) and Warning (4).

  • Default - Default value. Matches any HealthState. The value is zero.
  • None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.
  • Ok - Filter that matches input with HealthState value Ok. The value is 2.
  • Warning - Filter that matches input with HealthState value Warning. The value is 4.
  • Error - Filter that matches input with HealthState value Error. The value is 8.
  • All - Filter that matches input with any HealthState value. The value is 65535. Default value: 0.

Optional serviceManifestNameFilter

serviceManifestNameFilter: undefined | string

The name of the service manifest which identifies the deployed service packages that matches the filter. If specified, the filter is applied only to the specified deployed service packages, if any. If no deployed service packages with specified manifest name exist, nothing is returned in the cluster health chunk based on this filter. If any deployed service package exists, they are included in the cluster health chunk if it respects the other filter properties. If not specified, all deployed service packages that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.

Optional servicePackageActivationIdFilter

servicePackageActivationIdFilter: undefined | string

The activation ID of a deployed service package that matches the filter. If not specified, the filter applies to all deployed service packages that match the other parameters. If specified, the filter matches only the deployed service package with the specified activation ID.

serializedName

serializedName: string = "DeployedServicePackageHealthStateFilter"

type

type: object

className

className: string = "DeployedServicePackageHealthStateFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

healthStateFilter

healthStateFilter: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "HealthStateFilter"

type

type: object

name

name: "Number" = "Number"

serviceManifestNameFilter

serviceManifestNameFilter: object

serializedName

serializedName: string = "ServiceManifestNameFilter"

type

type: object

name

name: "String" = "String"

servicePackageActivationIdFilter

servicePackageActivationIdFilter: object

serializedName

serializedName: string = "ServicePackageActivationIdFilter"

type

type: object

name

name: "String" = "String"

Const DeployedServicePackageInfo

DeployedServicePackageInfo: object

Information about service package deployed on a Service Fabric node.

Optional name

name: undefined | string

The name of the service package as specified in the service manifest.

Optional servicePackageActivationId

servicePackageActivationId: undefined | string

The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.

Optional status

Specifies the status of a deployed application or service package on a Service Fabric node. Possible values include: 'Invalid', 'Downloading', 'Activating', 'Active', 'Upgrading', 'Deactivating'

Optional version

version: undefined | string

The version of the service package specified in service manifest.

serializedName

serializedName: string = "DeployedServicePackageInfo"

type

type: object

className

className: string = "DeployedServicePackageInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

servicePackageActivationId

servicePackageActivationId: object

serializedName

serializedName: string = "ServicePackageActivationId"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "Status"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "Version"

type

type: object

name

name: "String" = "String"

Const DeployedServicePackageNewHealthReportEvent

DeployedServicePackageNewHealthReportEvent: object

Deployed Service Health Report Created event.

applicationId

applicationId: string

The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

Optional category

category: undefined | string

The category of event.

description

description: string

Description of report.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

healthState

healthState: string

Describes the property health state.

kind

kind: "DeployedServicePackageNewHealthReport"

Polymorphic Discriminator

nodeName

nodeName: string

The name of a Service Fabric node.

property

property: string

Describes the property.

removeWhenExpired

removeWhenExpired: boolean

Indicates the removal when it expires.

sequenceNumber

sequenceNumber: number

Sequence number of report.

serviceManifestName

serviceManifestName: string

Service manifest name.

servicePackageActivationId

servicePackageActivationId: string

Id of Service package activation.

servicePackageInstanceId

servicePackageInstanceId: number

Id of Service package instance.

sourceId

sourceId: string

Id of report source.

sourceUtcTimestamp

sourceUtcTimestamp: Date

Source time.

timeStamp

timeStamp: Date

The time event was logged.

timeToLiveMs

timeToLiveMs: number

Time to live in milli-seconds.

serializedName

serializedName: string = "DeployedServicePackageNewHealthReport"

type

type: object

className

className: string = "DeployedServicePackageNewHealthReportEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

description

description: object

required

required: true = true

serializedName

serializedName: string = "Description"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

required

required: true = true

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

nodeName

nodeName: object

required

required: true = true

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

property

property: object

required

required: true = true

serializedName

serializedName: string = "Property"

type

type: object

name

name: "String" = "String"

removeWhenExpired

removeWhenExpired: object

required

required: true = true

serializedName

serializedName: string = "RemoveWhenExpired"

type

type: object

name

name: "Boolean" = "Boolean"

sequenceNumber

sequenceNumber: object

required

required: true = true

serializedName

serializedName: string = "SequenceNumber"

type

type: object

name

name: "Number" = "Number"

serviceManifestName

serviceManifestName: object

required

required: true = true

serializedName

serializedName: string = "ServiceManifestName"

type

type: object

name

name: "String" = "String"

servicePackageActivationId

servicePackageActivationId: object

required

required: true = true

serializedName

serializedName: string = "ServicePackageActivationId"

type

type: object

name

name: "String" = "String"

servicePackageInstanceId

servicePackageInstanceId: object

required

required: true = true

serializedName

serializedName: string = "ServicePackageInstanceId"

type

type: object

name

name: "Number" = "Number"

sourceId

sourceId: object

required

required: true = true

serializedName

serializedName: string = "SourceId"

type

type: object

name

name: "String" = "String"

sourceUtcTimestamp

sourceUtcTimestamp: object

required

required: true = true

serializedName

serializedName: string = "SourceUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

timeToLiveMs

timeToLiveMs: object

required

required: true = true

serializedName

serializedName: string = "TimeToLiveMs"

type

type: object

name

name: "Number" = "Number"

Const DeployedServicePackagesHealthEvaluation

DeployedServicePackagesHealthEvaluation: object

Represents health evaluation for deployed service packages, containing health evaluations for each unhealthy deployed service package that impacted current aggregated health state. Can be returned when evaluating deployed application health and the aggregated health state is either Error or Warning.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional description

description: undefined | string

Description of the health evaluation, which represents a summary of the evaluation process.

kind

kind: "DeployedServicePackages"

Polymorphic Discriminator

Optional totalCount

totalCount: undefined | number

Total number of deployed service packages of the deployed application in the health store.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy DeployedServicePackageHealthEvaluation that impacted the aggregated health.

serializedName

serializedName: string = "DeployedServicePackages"

type

type: object

className

className: string = "DeployedServicePackagesHealthEvaluation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = HealthEvaluation.type.polymorphicDiscriminator

uberParent

uberParent: string = "HealthEvaluation"

modelProperties

modelProperties: object

totalCount

totalCount: object

serializedName

serializedName: string = "TotalCount"

type

type: object

name

name: "Number" = "Number"

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

Const DeployedServiceReplicaDetailInfo

DeployedServiceReplicaDetailInfo: object

Information about a Service Fabric service replica deployed on a node.

Optional currentServiceOperation

currentServiceOperation: ServiceOperationName

Specifies the current active life-cycle operation on a stateful service replica or stateless service instance. Possible values include: 'Unknown', 'None', 'Open', 'ChangeRole', 'Close', 'Abort'

Optional currentServiceOperationStartTimeUtc

currentServiceOperationStartTimeUtc: Date

The start time of the current service operation in UTC format.

Optional partitionId

partitionId: undefined | string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

Optional reportedLoad

reportedLoad: LoadMetricReportInfo[]

List of load reported by replica.

serviceKind

serviceKind: "DeployedServiceReplicaDetailInfo"

Polymorphic Discriminator

Optional serviceName

serviceName: undefined | string

Full hierarchical name of the service in URI format starting with fabric:.

serializedName

serializedName: string = "DeployedServiceReplicaDetailInfo"

type

type: object

className

className: string = "DeployedServiceReplicaDetailInfo"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "DeployedServiceReplicaDetailInfo"

modelProperties

modelProperties: object

currentServiceOperation

currentServiceOperation: object

serializedName

serializedName: string = "CurrentServiceOperation"

type

type: object

name

name: "String" = "String"

currentServiceOperationStartTimeUtc

currentServiceOperationStartTimeUtc: object

serializedName

serializedName: string = "CurrentServiceOperationStartTimeUtc"

type

type: object

name

name: "DateTime" = "DateTime"

partitionId

partitionId: object

serializedName

serializedName: string = "PartitionId"

type

type: object

name

name: "Uuid" = "Uuid"

reportedLoad

reportedLoad: object

serializedName

serializedName: string = "ReportedLoad"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LoadMetricReportInfo"

name

name: "Composite" = "Composite"

serviceKind

serviceKind: object

required

required: true = true

serializedName

serializedName: string = "ServiceKind"

type

type: object

name

name: "String" = "String"

serviceName

serviceName: object

serializedName

serializedName: string = "ServiceName"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "serviceKind"

serializedName

serializedName: string = "ServiceKind"

Const DeployedServiceReplicaInfo

DeployedServiceReplicaInfo: object

Information about a Service Fabric service replica deployed on a node.

Optional address

address: undefined | string

The last address returned by the replica in Open or ChangeRole.

Optional codePackageName

codePackageName: undefined | string

The name of the code package that hosts this replica.

Optional hostProcessId

hostProcessId: undefined | string

Host process ID of the process that is hosting the replica. This will be zero if the replica is down. In hyper-v containers this host process ID will be from different kernel.

Optional partitionId

partitionId: undefined | string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

Optional replicaStatus

replicaStatus: ReplicaStatus

The status of a replica of a service. Possible values include: 'Invalid', 'InBuild', 'Standby', 'Ready', 'Down', 'Dropped'

serviceKind

serviceKind: "DeployedServiceReplicaInfo"

Polymorphic Discriminator

Optional serviceManifestName

serviceManifestName: undefined | string

The name of the service manifest in which this service type is defined.

Optional serviceName

serviceName: undefined | string

The full name of the service with 'fabric:' URI scheme.

Optional servicePackageActivationId

servicePackageActivationId: undefined | string

The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.

Optional serviceTypeName

serviceTypeName: undefined | string

Name of the service type as specified in the service manifest.

serializedName

serializedName: string = "DeployedServiceReplicaInfo"

type

type: object

className

className: string = "DeployedServiceReplicaInfo"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "DeployedServiceReplicaInfo"

modelProperties

modelProperties: object

address

address: object

serializedName

serializedName: string = "Address"

type

type: object

name

name: "String" = "String"

codePackageName

codePackageName: object

serializedName

serializedName: string = "CodePackageName"

type

type: object

name

name: "String" = "String"

hostProcessId

hostProcessId: object

serializedName

serializedName: string = "HostProcessId"

type

type: object

name

name: "String" = "String"

partitionId

partitionId: object

serializedName

serializedName: string = "PartitionId"

type

type: object

name

name: "Uuid" = "Uuid"

replicaStatus

replicaStatus: object

serializedName

serializedName: string = "ReplicaStatus"

type

type: object

name

name: "String" = "String"

serviceKind

serviceKind: object

required

required: true = true

serializedName

serializedName: string = "ServiceKind"

type

type: object

name

name: "String" = "String"

serviceManifestName

serviceManifestName: object

serializedName

serializedName: string = "ServiceManifestName"

type

type: object

name

name: "String" = "String"

serviceName

serviceName: object

serializedName

serializedName: string = "ServiceName"

type

type: object

name

name: "String" = "String"

servicePackageActivationId

servicePackageActivationId: object

serializedName

serializedName: string = "ServicePackageActivationId"

type

type: object

name

name: "String" = "String"

serviceTypeName

serviceTypeName: object

serializedName

serializedName: string = "ServiceTypeName"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "serviceKind"

serializedName

serializedName: string = "ServiceKind"

Const DeployedServiceTypeInfo

DeployedServiceTypeInfo: object

Information about service type deployed on a node, information such as the status of the service type registration on a node.

Optional codePackageName

codePackageName: undefined | string

The name of the code package that registered the service type.

Optional serviceManifestName

serviceManifestName: undefined | string

The name of the service manifest in which this service type is defined.

Optional servicePackageActivationId

servicePackageActivationId: undefined | string

The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.

Optional serviceTypeName

serviceTypeName: undefined | string

Name of the service type as specified in the service manifest.

Optional status

The status of the service type registration on the node. Possible values include: 'Invalid', 'Disabled', 'Enabled', 'Registered'

serializedName

serializedName: string = "DeployedServiceTypeInfo"

type

type: object

className

className: string = "DeployedServiceTypeInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

codePackageName

codePackageName: object

serializedName

serializedName: string = "CodePackageName"

type

type: object

name

name: "String" = "String"

serviceManifestName

serviceManifestName: object

serializedName

serializedName: string = "ServiceManifestName"

type

type: object

name

name: "String" = "String"

servicePackageActivationId

servicePackageActivationId: object

serializedName

serializedName: string = "ServicePackageActivationId"

type

type: object

name

name: "String" = "String"

serviceTypeName

serviceTypeName: object

serializedName

serializedName: string = "ServiceTypeName"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "Status"

type

type: object

name

name: "String" = "String"

Const DeployedStatefulServiceReplicaDetailInfo

DeployedStatefulServiceReplicaDetailInfo: object

Information about a stateful replica running in a code package. Note DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and replicaId.

Optional currentReplicatorOperation

currentReplicatorOperation: ReplicatorOperationName

Specifies the operation currently being executed by the Replicator. Possible values include: 'Invalid', 'None', 'Open', 'ChangeRole', 'UpdateEpoch', 'Close', 'Abort', 'OnDataLoss', 'WaitForCatchup', 'Build'

Optional currentServiceOperation

currentServiceOperation: ServiceOperationName

Specifies the current active life-cycle operation on a stateful service replica or stateless service instance. Possible values include: 'Unknown', 'None', 'Open', 'ChangeRole', 'Close', 'Abort'

Optional currentServiceOperationStartTimeUtc

currentServiceOperationStartTimeUtc: Date

The start time of the current service operation in UTC format.

Optional deployedServiceReplicaQueryResult

deployedServiceReplicaQueryResult: DeployedStatefulServiceReplicaInfo

Information about a stateful service replica deployed on a node.

Optional partitionId

partitionId: undefined | string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

Optional readStatus

Specifies the access status of the partition. Possible values include: 'Invalid', 'Granted', 'ReconfigurationPending', 'NotPrimary', 'NoWriteQuorum'

Optional replicaId

replicaId: undefined | string

Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.

Optional replicaStatus

Key value store related information for the replica.

Optional replicatorStatus

replicatorStatus: ReplicatorStatusUnion

Represents a base class for primary or secondary replicator status. Contains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc.

Optional reportedLoad

reportedLoad: LoadMetricReportInfo[]

List of load reported by replica.

serviceKind

serviceKind: "Stateful"

Polymorphic Discriminator

Optional serviceName

serviceName: undefined | string

Full hierarchical name of the service in URI format starting with fabric:.

Optional writeStatus

Specifies the access status of the partition. Possible values include: 'Invalid', 'Granted', 'ReconfigurationPending', 'NotPrimary', 'NoWriteQuorum'

serializedName

serializedName: string = "Stateful"

type

type: object

className

className: string = "DeployedStatefulServiceReplicaDetailInfo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = DeployedServiceReplicaDetailInfo.type.polymorphicDiscriminator

uberParent

uberParent: string = "DeployedServiceReplicaDetailInfo"

modelProperties

modelProperties: object

currentReplicatorOperation

currentReplicatorOperation: object

serializedName

serializedName: string = "CurrentReplicatorOperation"

type

type: object

name

name: "String" = "String"

deployedServiceReplicaQueryResult

deployedServiceReplicaQueryResult: object

serializedName

serializedName: string = "DeployedServiceReplicaQueryResult"

type

type: object

className

className: string = "DeployedStatefulServiceReplicaInfo"

name

name: "Composite" = "Composite"

readStatus

readStatus: object

serializedName

serializedName: string = "ReadStatus"

type

type: object

name

name: "String" = "String"

replicaId

replicaId: object

serializedName

serializedName: string = "ReplicaId"

type

type: object

name

name: "String" = "String"

replicaStatus

replicaStatus: object

serializedName

serializedName: string = "ReplicaStatus"

type

type: object

className

className: string = "KeyValueStoreReplicaStatus"

name

name: "Composite" = "Composite"

replicatorStatus

replicatorStatus: object

serializedName

serializedName: string = "ReplicatorStatus"

type

type: object

className

className: string = "ReplicatorStatus"

name

name: "Composite" = "Composite"

writeStatus

writeStatus: object

serializedName

serializedName: string = "WriteStatus"

type

type: object

name

name: "String" = "String"

Const DeployedStatefulServiceReplicaInfo

DeployedStatefulServiceReplicaInfo: object

Information about a stateful service replica deployed on a node.

Optional address

address: undefined | string

The last address returned by the replica in Open or ChangeRole.

Optional codePackageName

codePackageName: undefined | string

The name of the code package that hosts this replica.

Optional hostProcessId

hostProcessId: undefined | string

Host process ID of the process that is hosting the replica. This will be zero if the replica is down. In hyper-v containers this host process ID will be from different kernel.

Optional partitionId

partitionId: undefined | string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

Optional reconfigurationInformation

reconfigurationInformation: ReconfigurationInformation

Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time.

Optional replicaId

replicaId: undefined | string

Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.

Optional replicaRole

replicaRole: ReplicaRole

The role of a replica of a stateful service. Possible values include: 'Unknown', 'None', 'Primary', 'IdleSecondary', 'ActiveSecondary'

Optional replicaStatus

replicaStatus: ReplicaStatus

The status of a replica of a service. Possible values include: 'Invalid', 'InBuild', 'Standby', 'Ready', 'Down', 'Dropped'

serviceKind

serviceKind: "Stateful"

Polymorphic Discriminator

Optional serviceManifestName

serviceManifestName: undefined | string

The name of the service manifest in which this service type is defined.

Optional serviceName

serviceName: undefined | string

The full name of the service with 'fabric:' URI scheme.

Optional servicePackageActivationId

servicePackageActivationId: undefined | string

The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.

Optional serviceTypeName

serviceTypeName: undefined | string

Name of the service type as specified in the service manifest.

serializedName

serializedName: string = "Stateful"

type

type: object

className

className: string = "DeployedStatefulServiceReplicaInfo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = DeployedServiceReplicaInfo.type.polymorphicDiscriminator

uberParent

uberParent: string = "DeployedServiceReplicaInfo"

modelProperties

modelProperties: object

reconfigurationInformation

reconfigurationInformation: object

serializedName

serializedName: string = "ReconfigurationInformation"

type

type: object

className

className: string = "ReconfigurationInformation"

name

name: "Composite" = "Composite"

replicaId

replicaId: object

serializedName

serializedName: string = "ReplicaId"

type

type: object

name

name: "String" = "String"

replicaRole

replicaRole: object

serializedName

serializedName: string = "ReplicaRole"

type

type: object

name

name: "String" = "String"

Const DeployedStatelessServiceInstanceDetailInfo

DeployedStatelessServiceInstanceDetailInfo: object

Information about a stateless instance running in a code package. Note that DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and InstanceId.

Optional currentServiceOperation

currentServiceOperation: ServiceOperationName

Specifies the current active life-cycle operation on a stateful service replica or stateless service instance. Possible values include: 'Unknown', 'None', 'Open', 'ChangeRole', 'Close', 'Abort'

Optional currentServiceOperationStartTimeUtc

currentServiceOperationStartTimeUtc: Date

The start time of the current service operation in UTC format.

Optional deployedServiceReplicaQueryResult

deployedServiceReplicaQueryResult: DeployedStatelessServiceInstanceInfo

Information about a stateless service instance deployed on a node.

Optional instanceId

instanceId: undefined | string

Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId.

Optional partitionId

partitionId: undefined | string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

Optional reportedLoad

reportedLoad: LoadMetricReportInfo[]

List of load reported by replica.

serviceKind

serviceKind: "Stateless"

Polymorphic Discriminator

Optional serviceName

serviceName: undefined | string

Full hierarchical name of the service in URI format starting with fabric:.

serializedName

serializedName: string = "Stateless"

type

type: object

className

className: string = "DeployedStatelessServiceInstanceDetailInfo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = DeployedServiceReplicaDetailInfo.type.polymorphicDiscriminator

uberParent

uberParent: string = "DeployedServiceReplicaDetailInfo"

modelProperties

modelProperties: object

deployedServiceReplicaQueryResult

deployedServiceReplicaQueryResult: object

serializedName

serializedName: string = "DeployedServiceReplicaQueryResult"

type

type: object

className

className: string = "DeployedStatelessServiceInstanceInfo"

name

name: "Composite" = "Composite"

instanceId

instanceId: object

serializedName

serializedName: string = "InstanceId"

type

type: object

name

name: "String" = "String"

Const DeployedStatelessServiceInstanceInfo

DeployedStatelessServiceInstanceInfo: object

Information about a stateless service instance deployed on a node.

Optional address

address: undefined | string

The last address returned by the replica in Open or ChangeRole.

Optional codePackageName

codePackageName: undefined | string

The name of the code package that hosts this replica.

Optional hostProcessId

hostProcessId: undefined | string

Host process ID of the process that is hosting the replica. This will be zero if the replica is down. In hyper-v containers this host process ID will be from different kernel.

Optional instanceId

instanceId: undefined | string

Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId.

Optional partitionId

partitionId: undefined | string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

Optional replicaStatus

replicaStatus: ReplicaStatus

The status of a replica of a service. Possible values include: 'Invalid', 'InBuild', 'Standby', 'Ready', 'Down', 'Dropped'

serviceKind

serviceKind: "Stateless"

Polymorphic Discriminator

Optional serviceManifestName

serviceManifestName: undefined | string

The name of the service manifest in which this service type is defined.

Optional serviceName

serviceName: undefined | string

The full name of the service with 'fabric:' URI scheme.

Optional servicePackageActivationId

servicePackageActivationId: undefined | string

The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.

Optional serviceTypeName

serviceTypeName: undefined | string

Name of the service type as specified in the service manifest.

serializedName

serializedName: string = "Stateless"

type

type: object

className

className: string = "DeployedStatelessServiceInstanceInfo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = DeployedServiceReplicaInfo.type.polymorphicDiscriminator

uberParent

uberParent: string = "DeployedServiceReplicaInfo"

modelProperties

modelProperties: object

instanceId

instanceId: object

serializedName

serializedName: string = "InstanceId"

type

type: object

name

name: "String" = "String"

Const DiagnosticsDescription

DiagnosticsDescription: object

Describes the diagnostics options available

Optional defaultSinkRefs

defaultSinkRefs: string[]

The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level.

Optional enabled

enabled: undefined | false | true

Status of whether or not sinks are enabled.

Optional sinks

List of supported sinks that can be referenced.

serializedName

serializedName: string = "DiagnosticsDescription"

type

type: object

className

className: string = "DiagnosticsDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

defaultSinkRefs

defaultSinkRefs: object

serializedName

serializedName: string = "defaultSinkRefs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "Boolean" = "Boolean"

sinks

sinks: object

serializedName

serializedName: string = "sinks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DiagnosticsSinkProperties"

name

name: "Composite" = "Composite"

Const DiagnosticsRef

DiagnosticsRef: object

Reference to sinks in DiagnosticsDescription.

Optional enabled

enabled: undefined | false | true

Status of whether or not sinks are enabled.

Optional sinkRefs

sinkRefs: string[]

List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription.

serializedName

serializedName: string = "DiagnosticsRef"

type

type: object

className

className: string = "DiagnosticsRef"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "Boolean" = "Boolean"

sinkRefs

sinkRefs: object

serializedName

serializedName: string = "sinkRefs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const DiagnosticsSinkProperties

DiagnosticsSinkProperties: object

Properties of a DiagnosticsSink.

Optional description

description: undefined | string

A description of the sink.

kind

kind: "DiagnosticsSinkProperties"

Polymorphic Discriminator

Optional name

name: undefined | string

Name of the sink. This value is referenced by DiagnosticsReferenceDescription

serializedName

serializedName: string = "DiagnosticsSinkProperties"

type

type: object

className

className: string = "DiagnosticsSinkProperties"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "DiagnosticsSinkProperties"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "kind"

Const DisableBackupDescription

DisableBackupDescription: object

It describes the body parameters while disabling backup of a backup entity(Application/Service/Partition).

cleanBackup

cleanBackup: boolean

Boolean flag to delete backups. It can be set to true for deleting all the backups which were created for the backup entity that is getting disabled for backup.

serializedName

serializedName: string = "DisableBackupDescription"

type

type: object

className

className: string = "DisableBackupDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

cleanBackup

cleanBackup: object

required

required: true = true

serializedName

serializedName: string = "CleanBackup"

type

type: object

name

name: "Boolean" = "Boolean"

Const DoublePropertyValue

DoublePropertyValue: object

Describes a Service Fabric property value of type Double.

data

data: number

The data of the property value.

kind

kind: "Double"

Polymorphic Discriminator

serializedName

serializedName: string = "Double"

type

type: object

className

className: string = "DoublePropertyValue"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PropertyValue.type.polymorphicDiscriminator

uberParent

uberParent: string = "PropertyValue"

modelProperties

modelProperties: object

data

data: object

required

required: true = true

serializedName

serializedName: string = "Data"

type

type: object

name

name: "Number" = "Number"

Const EnableBackupDescription

EnableBackupDescription: object

Specifies the parameters needed to enable periodic backup.

backupPolicyName

backupPolicyName: string

Name of the backup policy to be used for enabling periodic backups.

serializedName

serializedName: string = "EnableBackupDescription"

type

type: object

className

className: string = "EnableBackupDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupPolicyName

backupPolicyName: object

required

required: true = true

serializedName

serializedName: string = "BackupPolicyName"

type

type: object

name

name: "String" = "String"

Const EndpointProperties

EndpointProperties: object

Describes a container endpoint.

name

name: string

The name of the endpoint.

Optional port

port: undefined | number

Port used by the container.

serializedName

serializedName: string = "EndpointProperties"

type

type: object

className

className: string = "EndpointProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

port

port: object

serializedName

serializedName: string = "port"

type

type: object

name

name: "Number" = "Number"

Const EndpointRef

EndpointRef: object

Describes a reference to a service endpoint.

Optional name

name: undefined | string

Name of the endpoint.

serializedName

serializedName: string = "EndpointRef"

type

type: object

className

className: string = "EndpointRef"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const EnsureAvailabilitySafetyCheck

EnsureAvailabilitySafetyCheck: object

Safety check that waits to ensure the availability of the partition. It waits until there are replicas available such that bringing down this replica will not cause availability loss for the partition.

kind

kind: "EnsureAvailability"

Polymorphic Discriminator

Optional partitionId

partitionId: undefined | string

Id of the partition which is undergoing the safety check.

serializedName

serializedName: string = "EnsureAvailability"

type

type: object

className

className: string = "EnsureAvailabilitySafetyCheck"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = SafetyCheck.type.polymorphicDiscriminator

uberParent

uberParent: string = "SafetyCheck"

modelProperties

modelProperties: object

Const EnsurePartitionQuorumSafetyCheck

EnsurePartitionQuorumSafetyCheck: object

Safety check that ensures that a quorum of replicas are not lost for a partition.

kind

kind: "EnsurePartitionQuorum"

Polymorphic Discriminator

Optional partitionId

partitionId: undefined | string

Id of the partition which is undergoing the safety check.

serializedName

serializedName: string = "EnsurePartitionQuorum"

type

type: object

className

className: string = "EnsurePartitionQuorumSafetyCheck"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = SafetyCheck.type.polymorphicDiscriminator

uberParent

uberParent: string = "SafetyCheck"

modelProperties

modelProperties: object

Const EntityHealth

EntityHealth: object

Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional healthEvents

healthEvents: HealthEvent[]

The list of health events reported on the entity.

Optional healthStatistics

healthStatistics: HealthStatistics

Shows the health statistics for all children types of the queried entity.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.

serializedName

serializedName: string = "EntityHealth"

type

type: object

className

className: string = "EntityHealth"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

aggregatedHealthState

aggregatedHealthState: object

serializedName

serializedName: string = "AggregatedHealthState"

type

type: object

name

name: "String" = "String"

healthEvents

healthEvents: object

serializedName

serializedName: string = "HealthEvents"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvent"

name

name: "Composite" = "Composite"

healthStatistics

healthStatistics: object

serializedName

serializedName: string = "HealthStatistics"

type

type: object

className

className: string = "HealthStatistics"

name

name: "Composite" = "Composite"

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

Const EntityHealthState

EntityHealthState: object

A base type for the health state of various entities in the cluster. It contains the aggregated health state.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

serializedName

serializedName: string = "EntityHealthState"

type

type: object

className

className: string = "EntityHealthState"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

aggregatedHealthState

aggregatedHealthState: object

serializedName

serializedName: string = "AggregatedHealthState"

type

type: object

name

name: "String" = "String"

Const EntityHealthStateChunk

EntityHealthStateChunk: object

A base type for the health state chunk of various entities in the cluster. It contains the aggregated health state.

Optional healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

serializedName

serializedName: string = "EntityHealthStateChunk"

type

type: object

className

className: string = "EntityHealthStateChunk"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

healthState

healthState: object

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

Const EntityHealthStateChunkList

EntityHealthStateChunkList: object

A base type for the list of health state chunks found in the cluster. It contains the total number of health states that match the input filters.

Optional totalCount

totalCount: undefined | number

Total number of entity health state objects that match the specified filters from the cluster health chunk query description.

serializedName

serializedName: string = "EntityHealthStateChunkList"

type

type: object

className

className: string = "EntityHealthStateChunkList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

totalCount

totalCount: object

serializedName

serializedName: string = "TotalCount"

type

type: object

name

name: "Number" = "Number"

Const EntityKindHealthStateCount

EntityKindHealthStateCount: object

Represents health state count for entities of the specified entity kind.

Optional entityKind

entityKind: EntityKind

The entity kind for which health states are evaluated. Possible values include: 'Invalid', 'Node', 'Partition', 'Service', 'Application', 'Replica', 'DeployedApplication', 'DeployedServicePackage', 'Cluster'

Optional healthStateCount

healthStateCount: HealthStateCount

The health state count for the entities of the specified kind.

serializedName

serializedName: string = "EntityKindHealthStateCount"

type

type: object

className

className: string = "EntityKindHealthStateCount"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

entityKind

entityKind: object

serializedName

serializedName: string = "EntityKind"

type

type: object

name

name: "String" = "String"

healthStateCount

healthStateCount: object

serializedName

serializedName: string = "HealthStateCount"

type

type: object

className

className: string = "HealthStateCount"

name

name: "Composite" = "Composite"

Const EnvironmentVariable

EnvironmentVariable: object

Describes an environment variable for the container.

Optional name

name: undefined | string

The name of the environment variable.

Optional value

value: undefined | string

The value of the environment variable.

serializedName

serializedName: string = "EnvironmentVariable"

type

type: object

className

className: string = "EnvironmentVariable"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const Epoch

Epoch: object

An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica.

Optional configurationVersion

configurationVersion: undefined | string

The current configuration number of this Epoch. The configuration number is an increasing value that is updated whenever the configuration of this replica set changes.

Optional dataLossVersion

dataLossVersion: undefined | string

The current data loss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica.

serializedName

serializedName: string = "Epoch"

type

type: object

className

className: string = "Epoch"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

configurationVersion

configurationVersion: object

serializedName

serializedName: string = "ConfigurationVersion"

type

type: object

name

name: "String" = "String"

dataLossVersion

dataLossVersion: object

serializedName

serializedName: string = "DataLossVersion"

type

type: object

name

name: "String" = "String"

Const EventHealthEvaluation

EventHealthEvaluation: object

Represents health evaluation of a HealthEvent that was reported on the entity. The health evaluation is returned when evaluating health of an entity results in Error or Warning.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional considerWarningAsError

considerWarningAsError: undefined | false | true

Indicates whether warnings are treated with the same severity as errors. The field is specified in the health policy used to evaluate the entity.

Optional description

description: undefined | string

Description of the health evaluation, which represents a summary of the evaluation process.

kind

kind: "Event"

Polymorphic Discriminator

Optional unhealthyEvent

unhealthyEvent: HealthEvent

Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.

serializedName

serializedName: string = "Event"

type

type: object

className

className: string = "EventHealthEvaluation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = HealthEvaluation.type.polymorphicDiscriminator

uberParent

uberParent: string = "HealthEvaluation"

modelProperties

modelProperties: object

considerWarningAsError

considerWarningAsError: object

serializedName

serializedName: string = "ConsiderWarningAsError"

type

type: object

name

name: "Boolean" = "Boolean"

unhealthyEvent

unhealthyEvent: object

serializedName

serializedName: string = "UnhealthyEvent"

type

type: object

className

className: string = "HealthEvent"

name

name: "Composite" = "Composite"

Const ExecutingFaultsChaosEvent

ExecutingFaultsChaosEvent: object

Describes a Chaos event that gets generated when Chaos has decided on the faults for an iteration. This Chaos event contains the details of the faults as a list of strings.

Optional faults

faults: string[]

List of string description of the faults that Chaos decided to execute in an iteration.

kind

kind: "ExecutingFaults"

Polymorphic Discriminator

timeStampUtc

timeStampUtc: Date

The UTC timestamp when this Chaos event was generated.

serializedName

serializedName: string = "ExecutingFaults"

type

type: object

className

className: string = "ExecutingFaultsChaosEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ChaosEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "ChaosEvent"

modelProperties

modelProperties: object

faults

faults: object

serializedName

serializedName: string = "Faults"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const ExternalStoreProvisionApplicationTypeDescription

ExternalStoreProvisionApplicationTypeDescription: object

Describes the operation to register or provision an application type using an application package from an external store instead of a package uploaded to the Service Fabric image store.

applicationPackageDownloadUri

applicationPackageDownloadUri: string

The path to the '.sfpkg' application package from where the application package can be downloaded using HTTP or HTTPS protocols. The application package can be stored in an external store that provides GET operation to download the file. Supported protocols are HTTP and HTTPS, and the path must allow READ access.

applicationTypeName

applicationTypeName: string

The application type name represents the name of the application type found in the application manifest.

applicationTypeVersion

applicationTypeVersion: string

The application type version represents the version of the application type found in the application manifest.

async

async: boolean

Indicates whether or not provisioning should occur asynchronously. When set to true, the provision operation returns when the request is accepted by the system, and the provision operation continues without any timeout limit. The default value is false. For large application packages, we recommend setting the value to true.

kind

kind: "ExternalStore"

Polymorphic Discriminator

serializedName

serializedName: string = "ExternalStore"

type

type: object

className

className: string = "ExternalStoreProvisionApplicationTypeDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProvisionApplicationTypeDescriptionBase.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProvisionApplicationTypeDescriptionBase"

modelProperties

modelProperties: object

applicationPackageDownloadUri

applicationPackageDownloadUri: object

required

required: true = true

serializedName

serializedName: string = "ApplicationPackageDownloadUri"

type

type: object

name

name: "String" = "String"

applicationTypeName

applicationTypeName: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeName"

type

type: object

name

name: "String" = "String"

applicationTypeVersion

applicationTypeVersion: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeVersion"

type

type: object

name

name: "String" = "String"

Const FabricCodeVersionInfo

FabricCodeVersionInfo: object

Information about a Service Fabric code version.

Optional codeVersion

codeVersion: undefined | string

The product version of Service Fabric.

serializedName

serializedName: string = "FabricCodeVersionInfo"

type

type: object

className

className: string = "FabricCodeVersionInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

codeVersion

codeVersion: object

serializedName

serializedName: string = "CodeVersion"

type

type: object

name

name: "String" = "String"

Const FabricConfigVersionInfo

FabricConfigVersionInfo: object

Information about a Service Fabric config version.

Optional configVersion

configVersion: undefined | string

The config version of Service Fabric.

serializedName

serializedName: string = "FabricConfigVersionInfo"

type

type: object

className

className: string = "FabricConfigVersionInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

configVersion

configVersion: object

serializedName

serializedName: string = "ConfigVersion"

type

type: object

name

name: "String" = "String"

Const FabricError

FabricError: object

The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API operations that are not successful.

error

Error object containing error code and error message.

serializedName

serializedName: string = "FabricError"

type

type: object

className

className: string = "FabricError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

error

error: object

required

required: true = true

serializedName

serializedName: string = "Error"

type

type: object

className

className: string = "FabricErrorError"

name

name: "Composite" = "Composite"

Const FabricErrorError

FabricErrorError: object

Error object containing error code and error message.

code

Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.

  • Possible values of the error code for HTTP status code 400 (Bad Request)
  • "FABRIC_E_INVALID_PARTITION_KEY"
  • "FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR"
  • "FABRIC_E_INVALID_ADDRESS"
  • "FABRIC_E_APPLICATION_NOT_UPGRADING"
  • "FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR"
  • "FABRIC_E_FABRIC_NOT_UPGRADING"
  • "FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR"
  • "FABRIC_E_INVALID_CONFIGURATION"
  • "FABRIC_E_INVALID_NAME_URI"
  • "FABRIC_E_PATH_TOO_LONG"
  • "FABRIC_E_KEY_TOO_LARGE"
  • "FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED"
  • "FABRIC_E_INVALID_ATOMIC_GROUP"
  • "FABRIC_E_VALUE_EMPTY"
  • "FABRIC_E_BACKUP_IS_ENABLED"
  • "FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH"
  • "FABRIC_E_INVALID_FOR_STATELESS_SERVICES"
  • "FABRIC_E_INVALID_SERVICE_SCALING_POLICY"
  • "E_INVALIDARG"

  • Possible values of the error code for HTTP status code 404 (Not Found)

  • "FABRIC_E_NODE_NOT_FOUND"
  • "FABRIC_E_APPLICATION_TYPE_NOT_FOUND"
  • "FABRIC_E_APPLICATION_NOT_FOUND"
  • "FABRIC_E_SERVICE_TYPE_NOT_FOUND"
  • "FABRIC_E_SERVICE_DOES_NOT_EXIST"
  • "FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND"
  • "FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND"
  • "FABRIC_E_PARTITION_NOT_FOUND"
  • "FABRIC_E_REPLICA_DOES_NOT_EXIST"
  • "FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST"
  • "FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND"
  • "FABRIC_E_DIRECTORY_NOT_FOUND"
  • "FABRIC_E_FABRIC_VERSION_NOT_FOUND"
  • "FABRIC_E_FILE_NOT_FOUND"
  • "FABRIC_E_NAME_DOES_NOT_EXIST"
  • "FABRIC_E_PROPERTY_DOES_NOT_EXIST"
  • "FABRIC_E_ENUMERATION_COMPLETED"
  • "FABRIC_E_SERVICE_MANIFEST_NOT_FOUND"
  • "FABRIC_E_KEY_NOT_FOUND"
  • "FABRIC_E_HEALTH_ENTITY_NOT_FOUND"
  • "FABRIC_E_BACKUP_NOT_ENABLED"
  • "FABRIC_E_BACKUP_POLICY_NOT_EXISTING"
  • "FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING"
  • "FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR"

  • Possible values of the error code for HTTP status code 409 (Conflict)

  • "FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS"
  • "FABRIC_E_APPLICATION_ALREADY_EXISTS"
  • "FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION"
  • "FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS"
  • "FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS"
  • "FABRIC_E_SERVICE_ALREADY_EXISTS"
  • "FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS"
  • "FABRIC_E_APPLICATION_TYPE_IN_USE"
  • "FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION"
  • "FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS"
  • "FABRIC_E_FABRIC_VERSION_IN_USE"
  • "FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS"
  • "FABRIC_E_NAME_ALREADY_EXISTS"
  • "FABRIC_E_NAME_NOT_EMPTY"
  • "FABRIC_E_PROPERTY_CHECK_FAILED"
  • "FABRIC_E_SERVICE_METADATA_MISMATCH"
  • "FABRIC_E_SERVICE_TYPE_MISMATCH"
  • "FABRIC_E_HEALTH_STALE_REPORT"
  • "FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED"
  • "FABRIC_E_NODE_HAS_NOT_STOPPED_YET"
  • "FABRIC_E_INSTANCE_ID_MISMATCH"
  • "FABRIC_E_BACKUP_IN_PROGRESS"
  • "FABRIC_E_RESTORE_IN_PROGRESS"
  • "FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING"

  • Possible values of the error code for HTTP status code 413 (Request Entity Too Large)

  • "FABRIC_E_VALUE_TOO_LARGE"

  • Possible values of the error code for HTTP status code 500 (Internal Server Error)

  • "FABRIC_E_NODE_IS_UP"
  • "E_FAIL"
  • "FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS"
  • "FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND"
  • "FABRIC_E_VOLUME_ALREADY_EXISTS"
  • "FABRIC_E_VOLUME_NOT_FOUND"
  • "SerializationError"

  • Possible values of the error code for HTTP status code 503 (Service Unavailable)

  • "FABRIC_E_NO_WRITE_QUORUM"
  • "FABRIC_E_NOT_PRIMARY"
  • "FABRIC_E_NOT_READY"
  • "FABRIC_E_RECONFIGURATION_PENDING"
  • "FABRIC_E_SERVICE_OFFLINE"
  • "E_ABORT"
  • "FABRIC_E_VALUE_TOO_LARGE"

  • Possible values of the error code for HTTP status code 504 (Gateway Timeout)

  • "FABRIC_E_COMMUNICATION_ERROR"
  • "FABRIC_E_OPERATION_NOT_COMPLETE"
  • "FABRIC_E_TIMEOUT". Possible values include: 'FABRIC_E_INVALID_PARTITION_KEY', 'FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR', 'FABRIC_E_INVALID_ADDRESS', 'FABRIC_E_APPLICATION_NOT_UPGRADING', 'FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR', 'FABRIC_E_FABRIC_NOT_UPGRADING', 'FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR', 'FABRIC_E_INVALID_CONFIGURATION', 'FABRIC_E_INVALID_NAME_URI', 'FABRIC_E_PATH_TOO_LONG', 'FABRIC_E_KEY_TOO_LARGE', 'FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED', 'FABRIC_E_INVALID_ATOMIC_GROUP', 'FABRIC_E_VALUE_EMPTY', 'FABRIC_E_NODE_NOT_FOUND', 'FABRIC_E_APPLICATION_TYPE_NOT_FOUND', 'FABRIC_E_APPLICATION_NOT_FOUND', 'FABRIC_E_SERVICE_TYPE_NOT_FOUND', 'FABRIC_E_SERVICE_DOES_NOT_EXIST', 'FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND', 'FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND', 'FABRIC_E_PARTITION_NOT_FOUND', 'FABRIC_E_REPLICA_DOES_NOT_EXIST', 'FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST', 'FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND', 'FABRIC_E_DIRECTORY_NOT_FOUND', 'FABRIC_E_FABRIC_VERSION_NOT_FOUND', 'FABRIC_E_FILE_NOT_FOUND', 'FABRIC_E_NAME_DOES_NOT_EXIST', 'FABRIC_E_PROPERTY_DOES_NOT_EXIST', 'FABRIC_E_ENUMERATION_COMPLETED', 'FABRIC_E_SERVICE_MANIFEST_NOT_FOUND', 'FABRIC_E_KEY_NOT_FOUND', 'FABRIC_E_HEALTH_ENTITY_NOT_FOUND', 'FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS', 'FABRIC_E_APPLICATION_ALREADY_EXISTS', 'FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION', 'FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS', 'FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS', 'FABRIC_E_SERVICE_ALREADY_EXISTS', 'FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS', 'FABRIC_E_APPLICATION_TYPE_IN_USE', 'FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION', 'FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS', 'FABRIC_E_FABRIC_VERSION_IN_USE', 'FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS', 'FABRIC_E_NAME_ALREADY_EXISTS', 'FABRIC_E_NAME_NOT_EMPTY', 'FABRIC_E_PROPERTY_CHECK_FAILED', 'FABRIC_E_SERVICE_METADATA_MISMATCH', 'FABRIC_E_SERVICE_TYPE_MISMATCH', 'FABRIC_E_HEALTH_STALE_REPORT', 'FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED', 'FABRIC_E_NODE_HAS_NOT_STOPPED_YET', 'FABRIC_E_INSTANCE_ID_MISMATCH', 'FABRIC_E_VALUE_TOO_LARGE', 'FABRIC_E_NO_WRITE_QUORUM', 'FABRIC_E_NOT_PRIMARY', 'FABRIC_E_NOT_READY', 'FABRIC_E_RECONFIGURATION_PENDING', 'FABRIC_E_SERVICE_OFFLINE', 'E_ABORT', 'FABRIC_E_COMMUNICATION_ERROR', 'FABRIC_E_OPERATION_NOT_COMPLETE', 'FABRIC_E_TIMEOUT', 'FABRIC_E_NODE_IS_UP', 'E_FAIL', 'FABRIC_E_BACKUP_IS_ENABLED', 'FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH', 'FABRIC_E_INVALID_FOR_STATELESS_SERVICES', 'FABRIC_E_BACKUP_NOT_ENABLED', 'FABRIC_E_BACKUP_POLICY_NOT_EXISTING', 'FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING', 'FABRIC_E_BACKUP_IN_PROGRESS', 'FABRIC_E_RESTORE_IN_PROGRESS', 'FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING', 'FABRIC_E_INVALID_SERVICE_SCALING_POLICY', 'E_INVALIDARG', 'FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS', 'FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND', 'FABRIC_E_VOLUME_ALREADY_EXISTS', 'FABRIC_E_VOLUME_NOT_FOUND', 'SerializationError', 'FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR'

Optional message

message: undefined | string

Error message.

serializedName

serializedName: string = "FabricErrorError"

type

type: object

className

className: string = "FabricErrorError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: true = true

serializedName

serializedName: string = "Code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "Message"

type

type: object

name

name: "String" = "String"

Const FabricEvent

FabricEvent: object

Represents the base for all Fabric Events.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "FabricEvent"

Polymorphic Discriminator

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "FabricEvent"

type

type: object

className

className: string = "FabricEvent"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

category

category: object

serializedName

serializedName: string = "Category"

type

type: object

name

name: "String" = "String"

eventInstanceId

eventInstanceId: object

required

required: true = true

serializedName

serializedName: string = "EventInstanceId"

type

type: object

name

name: "Uuid" = "Uuid"

hasCorrelatedEvents

hasCorrelatedEvents: object

serializedName

serializedName: string = "HasCorrelatedEvents"

type

type: object

name

name: "Boolean" = "Boolean"

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "Kind"

type

type: object

name

name: "String" = "String"

timeStamp

timeStamp: object

required

required: true = true

serializedName

serializedName: string = "TimeStamp"

type

type: object

name

name: "DateTime" = "DateTime"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "Kind"

Const FailedPropertyBatchInfo

FailedPropertyBatchInfo: object

Derived from PropertyBatchInfo. Represents the property batch failing. Contains information about the specific batch failure.

Optional errorMessage

errorMessage: undefined | string

The error message of the failed operation. Describes the exception thrown due to the first unsuccessful operation in the property batch.

kind

kind: "Failed"

Polymorphic Discriminator

Optional operationIndex

operationIndex: undefined | number

The index of the unsuccessful operation in the property batch.

serializedName

serializedName: string = "Failed"

type

type: object

className

className: string = "FailedPropertyBatchInfo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PropertyBatchInfo.type.polymorphicDiscriminator

uberParent

uberParent: string = "PropertyBatchInfo"

modelProperties

modelProperties: object

errorMessage

errorMessage: object

serializedName

serializedName: string = "ErrorMessage"

type

type: object

name

name: "String" = "String"

operationIndex

operationIndex: object

serializedName

serializedName: string = "OperationIndex"

type

type: object

name

name: "Number" = "Number"

Const FailedUpgradeDomainProgressObject

FailedUpgradeDomainProgressObject: object

The detailed upgrade progress for nodes in the current upgrade domain at the point of failure.

Optional domainName

domainName: undefined | string

The name of the upgrade domain

Optional nodeUpgradeProgressList

nodeUpgradeProgressList: NodeUpgradeProgressInfo[]

List of upgrading nodes and their statuses

serializedName

serializedName: string = "FailedUpgradeDomainProgressObject"

type

type: object

className

className: string = "FailedUpgradeDomainProgressObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

domainName

domainName: object

serializedName

serializedName: string = "DomainName"

type

type: object

name

name: "String" = "String"

nodeUpgradeProgressList

nodeUpgradeProgressList: object

serializedName

serializedName: string = "NodeUpgradeProgressList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NodeUpgradeProgressInfo"

name

name: "Composite" = "Composite"

Const FailureUpgradeDomainProgressInfo

FailureUpgradeDomainProgressInfo: object

Information about the upgrade domain progress at the time of upgrade failure.

Optional domainName

domainName: undefined | string

The name of the upgrade domain

Optional nodeUpgradeProgressList

nodeUpgradeProgressList: NodeUpgradeProgressInfo[]

List of upgrading nodes and their statuses

serializedName

serializedName: string = "FailureUpgradeDomainProgressInfo"

type

type: object

className

className: string = "FailureUpgradeDomainProgressInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

domainName

domainName: object

serializedName

serializedName: string = "DomainName"

type

type: object

name

name: "String" = "String"

nodeUpgradeProgressList

nodeUpgradeProgressList: object

serializedName

serializedName: string = "NodeUpgradeProgressList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NodeUpgradeProgressInfo"

name

name: "Composite" = "Composite"

Const FileInfo

FileInfo: object

Information about a image store file.

Optional fileSize

fileSize: undefined | string

The size of file in bytes.

Optional fileVersion

fileVersion: FileVersion

Information about the version of image store file.

Optional modifiedDate

modifiedDate: Date

The date and time when the image store file was last modified.

Optional storeRelativePath

storeRelativePath: undefined | string

The file path relative to the image store root path.

serializedName

serializedName: string = "FileInfo"

type

type: object

className

className: string = "FileInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

fileSize

fileSize: object

serializedName

serializedName: string = "FileSize"

type

type: object

name

name: "String" = "String"

fileVersion

fileVersion: object

serializedName

serializedName: string = "FileVersion"

type

type: object

className

className: string = "FileVersion"

name

name: "Composite" = "Composite"

modifiedDate

modifiedDate: object

serializedName

serializedName: string = "ModifiedDate"

type

type: object

name

name: "DateTime" = "DateTime"

storeRelativePath

storeRelativePath: object

serializedName

serializedName: string = "StoreRelativePath"

type

type: object

name

name: "String" = "String"

Const FileShareBackupStorageDescription

FileShareBackupStorageDescription: object

Describes the parameters for file share storage used for storing or enumerating backups.

Optional friendlyName

friendlyName: undefined | string

Friendly name for this backup storage.

path

path: string

UNC path of the file share where to store or enumerate backups from.

Optional primaryPassword

primaryPassword: undefined | string

Primary password to access the share location.

Optional primaryUserName

primaryUserName: undefined | string

Primary user name to access the file share.

Optional secondaryPassword

secondaryPassword: undefined | string

Secondary password to access the share location

Optional secondaryUserName

secondaryUserName: undefined | string

Secondary user name to access the file share.

storageKind

storageKind: "FileShare"

Polymorphic Discriminator

serializedName

serializedName: string = "FileShare"

type

type: object

className

className: string = "FileShareBackupStorageDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = BackupStorageDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "BackupStorageDescription"

modelProperties

modelProperties: object

path

path: object

required

required: true = true

serializedName

serializedName: string = "Path"

type

type: object

name

name: "String" = "String"

primaryPassword

primaryPassword: object

serializedName

serializedName: string = "PrimaryPassword"

type

type: object

name

name: "String" = "String"

primaryUserName

primaryUserName: object

serializedName

serializedName: string = "PrimaryUserName"

type

type: object

name

name: "String" = "String"

secondaryPassword

secondaryPassword: object

serializedName

serializedName: string = "SecondaryPassword"

type

type: object

name

name: "String" = "String"

secondaryUserName

secondaryUserName: object

serializedName

serializedName: string = "SecondaryUserName"

type

type: object

name

name: "String" = "String"

Const FileVersion

FileVersion: object

Information about the version of image store file.

Optional epochConfigurationNumber

epochConfigurationNumber: undefined | string

The epoch configuration version number of the image store replica when this file entry was created or updated.

Optional epochDataLossNumber

epochDataLossNumber: undefined | string

The epoch data loss number of image store replica when this file entry was updated or created.

Optional versionNumber

versionNumber: undefined | string

The current image store version number for the file is used in image store for checking whether it need to be updated.

serializedName

serializedName: string = "FileVersion"

type

type: object

className

className: string = "FileVersion"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

epochConfigurationNumber

epochConfigurationNumber: object

serializedName

serializedName: string = "EpochConfigurationNumber"

type

type: object

name

name: "String" = "String"

epochDataLossNumber

epochDataLossNumber: object

serializedName

serializedName: string = "EpochDataLossNumber"

type

type: object

name

name: "String" = "String"

versionNumber

versionNumber: object

serializedName

serializedName: string = "VersionNumber"

type

type: object

name

name: "String" = "String"

Const FolderInfo

FolderInfo: object

Information about a image store folder. It includes how many files this folder contains and its image store relative path.

Optional fileCount

fileCount: undefined | string

The number of files from within the image store folder.

Optional storeRelativePath

storeRelativePath: undefined | string

The remote location within image store. This path is relative to the image store root.

serializedName

serializedName: string = "FolderInfo"

type

type: object

className

className: string = "FolderInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

fileCount

fileCount: object

serializedName

serializedName: string = "FileCount"

type

type: object

name

name: "String" = "String"

storeRelativePath

storeRelativePath: object

serializedName

serializedName: string = "StoreRelativePath"

type

type: object

name

name: "String" = "String"

Const FolderSizeInfo

FolderSizeInfo: object

Information of a image store folder size

Optional folderSize

folderSize: undefined | string

The size of folder in bytes.

Optional storeRelativePath

storeRelativePath: undefined | string

The remote location within image store. This path is relative to the image store root.

serializedName

serializedName: string = "FolderSizeInfo"

type

type: object

className

className: string = "FolderSizeInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

folderSize

folderSize: object

serializedName

serializedName: string = "FolderSize"

type

type: object

name

name: "String" = "String"

storeRelativePath

storeRelativePath: object

serializedName

serializedName: string = "StoreRelativePath"

type

type: object

name

name: "String" = "String"

Const FrequencyBasedBackupScheduleDescription

FrequencyBasedBackupScheduleDescription: object

Describes the frequency based backup schedule.

interval

interval: string

Defines the interval with which backups are periodically taken. It should be specified in ISO8601 format. Timespan in seconds is not supported and will be ignored while creating the policy.

scheduleKind

scheduleKind: "FrequencyBased"

Polymorphic Discriminator

serializedName

serializedName: string = "FrequencyBased"

type

type: object

className

className: string = "FrequencyBasedBackupScheduleDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = BackupScheduleDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "BackupScheduleDescription"

modelProperties

modelProperties: object

interval

interval: object

required

required: true = true

serializedName

serializedName: string = "Interval"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const GatewayDestination

GatewayDestination: object

Describes destination endpoint for routing traffic.

applicationName

applicationName: string

Name of the service fabric Mesh application.

endpointName

endpointName: string

name of the endpoint in the service.

serviceName

serviceName: string

service that contains the endpoint.

serializedName

serializedName: string = "GatewayDestination"

type

type: object

className

className: string = "GatewayDestination"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationName

applicationName: object

required

required: true = true

serializedName

serializedName: string = "applicationName"

type

type: object

name

name: "String" = "String"

endpointName

endpointName: object

required

required: true = true

serializedName

serializedName: string = "endpointName"

type

type: object

name

name: "String" = "String"

serviceName

serviceName: object

required

required: true = true

serializedName

serializedName: string = "serviceName"

type

type: object

name

name: "String" = "String"

Const GatewayResourceDescription

GatewayResourceDescription: object

This type describes a gateway resource.

Optional description

description: undefined | string

User readable description of the gateway.

destinationNetwork

destinationNetwork: NetworkRef

Network that the Application is using.

Optional http

http: HttpConfig[]

Configuration for http connectivity for this gateway.

Optional ipAddress

ipAddress: undefined | string

IP address of the gateway. This is populated in the response and is ignored for incoming requests. NOTE: This property will not be serialized. It can only be populated by the server.

name

name: string

Name of the Gateway resource.

sourceNetwork

sourceNetwork: NetworkRef

Network the gateway should listen on for requests.

Optional status

Status of the resource. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional statusDetails

statusDetails: undefined | string

Gives additional information about the current status of the gateway. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tcp

tcp: TcpConfig[]

Configuration for tcp connectivity for this gateway.

serializedName

serializedName: string = "GatewayResourceDescription"

type

type: object

className

className: string = "GatewayResourceDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

destinationNetwork

destinationNetwork: object

required

required: true = true

serializedName

serializedName: string = "properties.destinationNetwork"

type

type: object

className

className: string = "NetworkRef"

name

name: "Composite" = "Composite"

http

http: object

serializedName

serializedName: string = "properties.http"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HttpConfig"

name

name: "Composite" = "Composite"

ipAddress

ipAddress: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.ipAddress"

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

sourceNetwork

sourceNetwork: object

required

required: true = true

serializedName

serializedName: string = "properties.sourceNetwork"

type

type: object

className

className: string = "NetworkRef"

name

name: "Composite" = "Composite"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

statusDetails

statusDetails: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.statusDetails"

type

type: object

name

name: "String" = "String"

tcp

tcp: object

serializedName

serializedName: string = "properties.tcp"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TcpConfig"

name

name: "Composite" = "Composite"

Const GetBackupByStorageQueryDescription

GetBackupByStorageQueryDescription: object

Describes additional filters to be applied, while listing backups, and backup storage details from where to fetch the backups.

backupEntity

backupEntity: BackupEntityUnion

Indicates the entity for which to enumerate backups.

Optional endDateTimeFilter

endDateTimeFilter: Date

Specifies the end date time in ISO8601 till which to enumerate backups. If not specified, backups are enumerated till the end.

Optional latest

latest: undefined | false | true

If specified as true, gets the most recent backup (within the specified time range) for every partition under the specified backup entity. Default value: false.

Optional startDateTimeFilter

startDateTimeFilter: Date

Specifies the start date time in ISO8601 from which to enumerate backups. If not specified, backups are enumerated from the beginning.

storage

Describes the parameters for the backup storage from where to enumerate backups. This is optional and by default backups are enumerated from the backup storage where this backup entity is currently being backed up (as specified in backup policy). This parameter is useful to be able to enumerate backups from another cluster where you may intend to restore.

serializedName

serializedName: string = "GetBackupByStorageQueryDescription"

type

type: object

className

className: string = "GetBackupByStorageQueryDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupEntity

backupEntity: object

required

required: true = true

serializedName

serializedName: string = "BackupEntity"

type

type: object

className

className: string = "BackupEntity"

name

name: "Composite" = "Composite"

endDateTimeFilter

endDateTimeFilter: object

serializedName

serializedName: string = "EndDateTimeFilter"

type

type: object

name

name: "DateTime" = "DateTime"

latest

latest: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "Latest"

type

type: object

name

name: "Boolean" = "Boolean"

startDateTimeFilter

startDateTimeFilter: object

serializedName

serializedName: string = "StartDateTimeFilter"

type

type: object

name

name: "DateTime" = "DateTime"

storage

storage: object

required

required: true = true

serializedName

serializedName: string = "Storage"

type

type: object

className

className: string = "BackupStorageDescription"

name

name: "Composite" = "Composite"

Const GetPropertyBatchOperation

GetPropertyBatchOperation: object

Represents a PropertyBatchOperation that gets the specified property if it exists. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.

Optional includeValue

includeValue: undefined | false | true

Whether or not to return the property value with the metadata. True if values should be returned with the metadata; False to return only property metadata. Default value: false.

kind

kind: "Get"

Polymorphic Discriminator

propertyName

propertyName: string

The name of the Service Fabric property.

serializedName

serializedName: string = "Get"

type

type: object

className

className: string = "GetPropertyBatchOperation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PropertyBatchOperation.type.polymorphicDiscriminator

uberParent

uberParent: string = "PropertyBatchOperation"

modelProperties

modelProperties: object

includeValue

includeValue: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "IncludeValue"

type

type: object

name

name: "Boolean" = "Boolean"

Const GuidPropertyValue

GuidPropertyValue: object

Describes a Service Fabric property value of type Guid.

data

data: string

The data of the property value.

kind

kind: "Guid"

Polymorphic Discriminator

serializedName

serializedName: string = "Guid"

type

type: object

className

className: string = "GuidPropertyValue"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PropertyValue.type.polymorphicDiscriminator

uberParent

uberParent: string = "PropertyValue"

modelProperties

modelProperties: object

data

data: object

required

required: true = true

serializedName

serializedName: string = "Data"

type

type: object

name

name: "Uuid" = "Uuid"

Const HealthEvaluation

HealthEvaluation: object

Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional description

description: undefined | string

Description of the health evaluation, which represents a summary of the evaluation process.

kind

kind: "HealthEvaluation"

Polymorphic Discriminator

serializedName

serializedName: string = "HealthEvaluation"

type

type: object

className

className: string = "HealthEvaluation"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "HealthEvaluation"

modelProperties

modelProperties: object

aggregatedHealthState

aggregatedHealthState: object

serializedName

serializedName: string = "AggregatedHealthState"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "Description"

type

type: object

name

name: "String" = "String"

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "Kind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "Kind"

Const HealthEvaluationWrapper

HealthEvaluationWrapper: object

Wrapper object for health evaluation.

Optional healthEvaluation

healthEvaluation: HealthEvaluationUnion

Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.

serializedName

serializedName: string = "HealthEvaluationWrapper"

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

healthEvaluation

healthEvaluation: object

serializedName

serializedName: string = "HealthEvaluation"

type

type: object

className

className: string = "HealthEvaluation"

name

name: "Composite" = "Composite"

Const HealthEvent

HealthEvent: object

Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.

Optional description

description: undefined | string

The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string.

healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional isExpired

isExpired: undefined | false | true

Returns true if the health event is expired, otherwise false.

Optional lastErrorTransitionAt

lastErrorTransitionAt: Date

If the current health state is 'Error', this property returns the time at which the health report was first reported with 'Error'. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first 'Error' health report was received.

If the current health state is 'Ok' or 'Warning', returns the date and time at which the health state was last in 'Error', before transitioning to a different state.

If the health state was never 'Error', the value will be zero date-time.

Optional lastModifiedUtcTimestamp

lastModifiedUtcTimestamp: Date

The date and time when the health report was last modified by the health store.

Optional lastOkTransitionAt

lastOkTransitionAt: Date

If the current health state is 'Ok', this property returns the time at which the health report was first reported with 'Ok'. For periodic reporting, many reports with the same state may have been generated. This property returns the date and time when the first 'Ok' health report was received.

If the current health state is 'Error' or 'Warning', returns the date and time at which the health state was last in 'Ok', before transitioning to a different state.

If the health state was never 'Ok', the value will be zero date-time.

Optional lastWarningTransitionAt

lastWarningTransitionAt: Date

If the current health state is 'Warning', this property returns the time at which the health report was first reported with 'Warning'. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first 'Warning' health report was received.

If the current health state is 'Ok' or 'Error', returns the date and time at which the health state was last in 'Warning', before transitioning to a different state.

If the health state was never 'Warning', the value will be zero date-time.

property

property: string

The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node.

Together with the SourceId, the property uniquely identifies the health information.

Optional removeWhenExpired

removeWhenExpired: undefined | false | true

Value that indicates whether the report is removed from health store when it expires. If set to true, the report is removed from the health store after it expires. If set to false, the report is treated as an error when expired. The value of this property is false by default. When clients report periodically, they should set RemoveWhenExpired false (default). This way, if the reporter has issues (e.g. deadlock) and can't report, the entity is evaluated at error when the health report expires. This flags the entity as being in Error health state.

Optional sequenceNumber

sequenceNumber: undefined | string

The sequence number for this health report as a numeric string. The report sequence number is used by the health store to detect stale reports. If not specified, a sequence number is auto-generated by the health client when a report is added.

sourceId

sourceId: string

The source name that identifies the client/watchdog/system component that generated the health information.

Optional sourceUtcTimestamp

sourceUtcTimestamp: Date

The date and time when the health report was sent by the source.

Optional timeToLiveInMilliSeconds

timeToLiveInMilliSeconds: undefined | string

The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. When clients report periodically, they should send reports with higher frequency than time to live. If clients report on transition, they can set the time to live to infinite. When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false.

If not specified, time to live defaults to infinite value.

serializedName

serializedName: string = "HealthEvent"

type

type: object

className

className: string = "HealthEvent"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

isExpired

isExpired: object

serializedName

serializedName: string = "IsExpired"

type

type: object

name

name: "Boolean" = "Boolean"

lastErrorTransitionAt

lastErrorTransitionAt: object

serializedName

serializedName: string = "LastErrorTransitionAt"

type

type: object

name

name: "DateTime" = "DateTime"

lastModifiedUtcTimestamp

lastModifiedUtcTimestamp: object

serializedName

serializedName: string = "LastModifiedUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

lastOkTransitionAt

lastOkTransitionAt: object

serializedName

serializedName: string = "LastOkTransitionAt"

type

type: object

name

name: "DateTime" = "DateTime"

lastWarningTransitionAt

lastWarningTransitionAt: object

serializedName

serializedName: string = "LastWarningTransitionAt"

type

type: object

name

name: "DateTime" = "DateTime"

sourceUtcTimestamp

sourceUtcTimestamp: object

serializedName

serializedName: string = "SourceUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

Const HealthInformation

HealthInformation: object

Represents common health report information. It is included in all health reports sent to health store and in all health events returned by health queries.

Optional description

description: undefined | string

The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string.

healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

property

property: string

The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node.

Together with the SourceId, the property uniquely identifies the health information.

Optional removeWhenExpired

removeWhenExpired: undefined | false | true

Value that indicates whether the report is removed from health store when it expires. If set to true, the report is removed from the health store after it expires. If set to false, the report is treated as an error when expired. The value of this property is false by default. When clients report periodically, they should set RemoveWhenExpired false (default). This way, if the reporter has issues (e.g. deadlock) and can't report, the entity is evaluated at error when the health report expires. This flags the entity as being in Error health state.

Optional sequenceNumber

sequenceNumber: undefined | string

The sequence number for this health report as a numeric string. The report sequence number is used by the health store to detect stale reports. If not specified, a sequence number is auto-generated by the health client when a report is added.

sourceId

sourceId: string

The source name that identifies the client/watchdog/system component that generated the health information.

Optional timeToLiveInMilliSeconds

timeToLiveInMilliSeconds: undefined | string

The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. When clients report periodically, they should send reports with higher frequency than time to live. If clients report on transition, they can set the time to live to infinite. When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false.

If not specified, time to live defaults to infinite value.

serializedName

serializedName: string = "HealthInformation"

type

type: object

className

className: string = "HealthInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "Description"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

required

required: true = true

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

property

property: object

required

required: true = true

serializedName

serializedName: string = "Property"

type

type: object

name

name: "String" = "String"

removeWhenExpired

removeWhenExpired: object

serializedName

serializedName: string = "RemoveWhenExpired"

type

type: object

name

name: "Boolean" = "Boolean"

sequenceNumber

sequenceNumber: object

serializedName

serializedName: string = "SequenceNumber"

type

type: object

name

name: "String" = "String"

sourceId

sourceId: object

required

required: true = true

serializedName

serializedName: string = "SourceId"

type

type: object

name

name: "String" = "String"

timeToLiveInMilliSeconds

timeToLiveInMilliSeconds: object

serializedName

serializedName: string = "TimeToLiveInMilliSeconds"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const HealthStateCount

HealthStateCount: object

Represents information about how many health entities are in Ok, Warning and Error health state.

Optional errorCount

errorCount: undefined | number

The number of health entities with aggregated health state Error.

Optional okCount

okCount: undefined | number

The number of health entities with aggregated health state Ok.

Optional warningCount

warningCount: undefined | number

The number of health entities with aggregated health state Warning.

serializedName

serializedName: string = "HealthStateCount"

type

type: object

className

className: string = "HealthStateCount"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

errorCount

errorCount: object

serializedName

serializedName: string = "ErrorCount"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

okCount

okCount: object

serializedName

serializedName: string = "OkCount"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

warningCount

warningCount: object

serializedName

serializedName: string = "WarningCount"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

Const HealthStatistics

HealthStatistics: object

The health statistics of an entity, returned as part of the health query result when the query description is configured to include statistics. The statistics include health state counts for all children types of the current entity. For example, for cluster, the health statistics include health state counts for nodes, applications, services, partitions, replicas, deployed applications and deployed service packages. For partition, the health statistics include health counts for replicas.

Optional healthStateCountList

healthStateCountList: EntityKindHealthStateCount[]

List of health state counts per entity kind, which keeps track of how many children of the queried entity are in Ok, Warning and Error state.

serializedName

serializedName: string = "HealthStatistics"

type

type: object

className

className: string = "HealthStatistics"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

healthStateCountList

healthStateCountList: object

serializedName

serializedName: string = "HealthStateCountList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EntityKindHealthStateCount"

name

name: "Composite" = "Composite"

Const HttpConfig

HttpConfig: object

Describes the http configuration for external connectivity for this network.

hosts

description for routing.

name

name: string

http gateway config name.

port

port: number

Specifies the port at which the service endpoint below needs to be exposed.

serializedName

serializedName: string = "HttpConfig"

type

type: object

className

className: string = "HttpConfig"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

hosts

hosts: object

required

required: true = true

serializedName

serializedName: string = "hosts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HttpHostConfig"

name

name: "Composite" = "Composite"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

port

port: object

required

required: true = true

serializedName

serializedName: string = "port"

type

type: object

name

name: "Number" = "Number"

Const HttpHostConfig

HttpHostConfig: object

Describes the hostname properties for http routing.

name

name: string

http hostname config name.

routes

routes: HttpRouteConfig[]

Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can handle general cases.

serializedName

serializedName: string = "HttpHostConfig"

type

type: object

className

className: string = "HttpHostConfig"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

routes

routes: object

required

required: true = true

serializedName

serializedName: string = "routes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HttpRouteConfig"

name

name: "Composite" = "Composite"

Const HttpRouteConfig

HttpRouteConfig: object

Describes the hostname properties for http routing.

destination

destination: GatewayDestination

Describes destination endpoint for routing traffic.

match

Describes a rule for http route matching.

name

name: string

http route name.

serializedName

serializedName: string = "HttpRouteConfig"

type

type: object

className

className: string = "HttpRouteConfig"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

destination

destination: object

required

required: true = true

serializedName

serializedName: string = "destination"

type

type: object

className

className: string = "GatewayDestination"

name

name: "Composite" = "Composite"

match

match: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "match"

type

type: object

className

className: string = "HttpRouteMatchRule"

name

name: "Composite" = "Composite"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const HttpRouteMatchHeader

HttpRouteMatchHeader: object

Describes header information for http route matching.

name

name: string

Name of header to match in request.

Optional value

value: undefined | string

Value of header to match in request.

serializedName

serializedName: string = "HttpRouteMatchHeader"

Optional type

type: object

how to match header value. Possible values include: 'exact'

className

className: string = "HttpRouteMatchHeader"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const HttpRouteMatchPath

HttpRouteMatchPath: object

Path to match for routing.

Optional rewrite

rewrite: undefined | string

replacement string for matched part of the Uri.

value

value: string

Uri path to match for request.

serializedName

serializedName: string = "HttpRouteMatchPath"

type

type: object

className

className: string = "HttpRouteMatchPath"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

rewrite

rewrite: object

serializedName

serializedName: string = "rewrite"

type

type: object

name

name: "String" = "String"

type

type: object

defaultValue

defaultValue: string = "prefix"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const HttpRouteMatchRule

HttpRouteMatchRule: object

Describes a rule for http route matching.

Optional headers

headers and their values to match in request.

path

Path to match for routing.

serializedName

serializedName: string = "HttpRouteMatchRule"

type

type: object

className

className: string = "HttpRouteMatchRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

headers

headers: object

serializedName

serializedName: string = "headers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HttpRouteMatchHeader"

name

name: "Composite" = "Composite"

path

path: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "path"

type

type: object

className

className: string = "HttpRouteMatchPath"

name

name: "Composite" = "Composite"

Const IdentityDescription

IdentityDescription: object

Information describing the identities associated with this application.

Optional principalId

principalId: undefined | string

the object identifier of the Service Principal of the identity associated with this resource.

Optional tenantId

tenantId: undefined | string

the identifier of the tenant containing the application's identity.

Optional tokenServiceEndpoint

tokenServiceEndpoint: undefined | string

the endpoint for the token service managing this identity

Optional userAssignedIdentities

userAssignedIdentities: undefined | object

represents user assigned identities map.

serializedName

serializedName: string = "IdentityDescription"

type

type: object

the types of identities associated with this resource; currently restricted to 'SystemAssigned and UserAssigned'

className

className: string = "IdentityDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

principalId

principalId: object

serializedName

serializedName: string = "principalId"

type

type: object

name

name: "String" = "String"

tenantId

tenantId: object

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: "String" = "String"

tokenServiceEndpoint

tokenServiceEndpoint: object

serializedName

serializedName: string = "tokenServiceEndpoint"

type

type: object

name

name: "String" = "String"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

userAssignedIdentities

userAssignedIdentities: object

serializedName

serializedName: string = "userAssignedIdentities"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "IdentityItemDescription"

name

name: "Composite" = "Composite"

Const IdentityItemDescription

IdentityItemDescription: object

Describes a single user-assigned identity associated with the application.

Optional clientId

clientId: undefined | string

the client identifier of the Service Principal which this identity represents.

Optional principalId

principalId: undefined | string

the object identifier of the Service Principal which this identity represents.

serializedName

serializedName: string = "IdentityItemDescription"

type

type: object

className

className: string = "IdentityItemDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientId

clientId: object

serializedName

serializedName: string = "clientId"

type

type: object

name

name: "String" = "String"

principalId

principalId: object

serializedName

serializedName: string = "principalId"

type

type: object

name

name: "String" = "String"

Const ImageRegistryCredential

ImageRegistryCredential: object

Image registry credential.

Optional password

password: undefined | string

The password for the private registry. The password is required for create or update operations, however it is not returned in the get or list operations.

server

server: string

Docker image registry server, without protocol such as http and https.

username

username: string

The username for the private registry.

serializedName

serializedName: string = "ImageRegistryCredential"

type

type: object

className

className: string = "ImageRegistryCredential"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

password

password: object

serializedName

serializedName: string = "password"

type

type: object

name

name: "String" = "String"

server

server: object

required

required: true = true

serializedName

serializedName: string = "server"

type

type: object

name

name: "String" = "String"

username

username: object

required

required: true = true

serializedName

serializedName: string = "username"

type

type: object

name

name: "String" = "String"

Const ImageStoreContent

ImageStoreContent: object

Information about the image store content.

Optional storeFiles

storeFiles: FileInfo[]

The list of image store file info objects represents files found under the given image store relative path.

Optional storeFolders

storeFolders: FolderInfo[]

The list of image store folder info objects represents subfolders found under the given image store relative path.

serializedName

serializedName: string = "ImageStoreContent"

type

type: object

className

className: string = "ImageStoreContent"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

storeFiles

storeFiles: object

serializedName

serializedName: string = "StoreFiles"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "FileInfo"

name

name: "Composite" = "Composite"

storeFolders

storeFolders: object

serializedName

serializedName: string = "StoreFolders"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "FolderInfo"

name

name: "Composite" = "Composite"

Const ImageStoreCopyDescription

ImageStoreCopyDescription: object

Information about how to copy image store content from one image store relative path to another image store relative path.

Optional checkMarkFile

checkMarkFile: undefined | false | true

Indicates whether to check mark file during copying. The property is true if checking mark file is required, false otherwise. The mark file is used to check whether the folder is well constructed. If the property is true and mark file does not exist, the copy is skipped.

remoteDestination

remoteDestination: string

The relative path of destination image store content to be copied to.

remoteSource

remoteSource: string

The relative path of source image store content to be copied from.

Optional skipFiles

skipFiles: string[]

The list of the file names to be skipped for copying.

serializedName

serializedName: string = "ImageStoreCopyDescription"

type

type: object

className

className: string = "ImageStoreCopyDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

checkMarkFile

checkMarkFile: object

serializedName

serializedName: string = "CheckMarkFile"

type

type: object

name

name: "Boolean" = "Boolean"

remoteDestination

remoteDestination: object

required

required: true = true

serializedName

serializedName: string = "RemoteDestination"

type

type: object

name

name: "String" = "String"

remoteSource

remoteSource: object

required

required: true = true

serializedName

serializedName: string = "RemoteSource"

type

type: object

name

name: "String" = "String"

skipFiles

skipFiles: object

serializedName

serializedName: string = "SkipFiles"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const InlinedValueSecretResourceProperties

InlinedValueSecretResourceProperties: object

Describes the properties of a secret resource whose value is provided explicitly as plaintext. The secret resource may have multiple values, each being uniquely versioned. The secret value of each version is stored encrypted, and delivered as plaintext into the context of applications referencing it.

Optional contentType

contentType: undefined | string

The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed.

Optional description

description: undefined | string

User readable description of the secret.

kind

kind: "inlinedValue"

Polymorphic Discriminator

Optional status

Status of the resource. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional statusDetails

statusDetails: undefined | string

Gives additional information about the current status of the secret. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "inlinedValue"

type

type: object

className

className: string = "InlinedValueSecretResourceProperties"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = SecretResourcePropertiesBase.type.polymorphicDiscriminator

uberParent

uberParent: string = "SecretResourcePropertiesBase"

modelProperties

modelProperties: object

Const Int64PropertyValue

Int64PropertyValue: object

Describes a Service Fabric property value of type Int64.

data

data: string

The data of the property value.

kind

kind: "Int64"

Polymorphic Discriminator

serializedName

serializedName: string = "Int64"

type

type: object

className

className: string = "Int64PropertyValue"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PropertyValue.type.polymorphicDiscriminator

uberParent

uberParent: string = "PropertyValue"

modelProperties

modelProperties: object

data

data: object

required

required: true = true

serializedName

serializedName: string = "Data"

type

type: object

name

name: "String" = "String"

Const Int64RangePartitionInformation

Int64RangePartitionInformation: object

Describes the partition information for the integer range that is based on partition schemes.

Optional highKey

highKey: undefined | string

Specifies the maximum key value handled by this partition.

Optional id

id: undefined | string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

Optional lowKey

lowKey: undefined | string

Specifies the minimum key value handled by this partition.

servicePartitionKind

servicePartitionKind: "Int64Range"

Polymorphic Discriminator

serializedName

serializedName: string = "Int64Range"

type

type: object

className

className: string = "Int64RangePartitionInformation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PartitionInformation.type.polymorphicDiscriminator

uberParent

uberParent: string = "PartitionInformation"

modelProperties

modelProperties: object

highKey

highKey: object

serializedName

serializedName: string = "HighKey"

type

type: object

name

name: "String" = "String"

lowKey

lowKey: object

serializedName

serializedName: string = "LowKey"

type

type: object

name

name: "String" = "String"

Const InvokeDataLossResult

InvokeDataLossResult: object

Represents information about an operation in a terminal state (Completed or Faulted).

Optional errorCode

errorCode: undefined | number

If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason.

Optional selectedPartition

selectedPartition: SelectedPartition

This class returns information about the partition that the user-induced operation acted upon.

serializedName

serializedName: string = "InvokeDataLossResult"

type

type: object

className

className: string = "InvokeDataLossResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "ErrorCode"

type

type: object

name

name: "Number" = "Number"

selectedPartition

selectedPartition: object

serializedName

serializedName: string = "SelectedPartition"

type

type: object

className

className: string = "SelectedPartition"

name

name: "Composite" = "Composite"

Const InvokeQuorumLossResult

InvokeQuorumLossResult: object

Represents information about an operation in a terminal state (Completed or Faulted).

Optional errorCode

errorCode: undefined | number

If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason.

Optional selectedPartition

selectedPartition: SelectedPartition

This class returns information about the partition that the user-induced operation acted upon.

serializedName

serializedName: string = "InvokeQuorumLossResult"

type

type: object

className

className: string = "InvokeQuorumLossResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "ErrorCode"

type

type: object

name

name: "Number" = "Number"

selectedPartition

selectedPartition: object

serializedName

serializedName: string = "SelectedPartition"

type

type: object

className

className: string = "SelectedPartition"

name

name: "Composite" = "Composite"

Const KeyValueStoreReplicaStatus

KeyValueStoreReplicaStatus: object

Key value store related information for the replica.

Optional copyNotificationCurrentKeyFilter

copyNotificationCurrentKeyFilter: undefined | string

Value indicating the latest key-prefix filter applied to enumeration during the callback. Null if there is no pending callback.

Optional copyNotificationCurrentProgress

copyNotificationCurrentProgress: undefined | string

Value indicating the latest number of keys enumerated during the callback. 0 if there is no pending callback.

Optional databaseLogicalSizeEstimate

databaseLogicalSizeEstimate: undefined | string

Value indicating the estimated size of the underlying database.

Optional databaseRowCountEstimate

databaseRowCountEstimate: undefined | string

Value indicating the estimated number of rows in the underlying database.

kind

kind: "KeyValueStore"

Polymorphic Discriminator

Optional statusDetails

statusDetails: undefined | string

Value indicating the current status details of the replica.

serializedName

serializedName: string = "KeyValueStore"

type

type: object

className

className: string = "KeyValueStoreReplicaStatus"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ReplicaStatusBase.type.polymorphicDiscriminator

uberParent

uberParent: string = "ReplicaStatusBase"

modelProperties

modelProperties: object

copyNotificationCurrentKeyFilter

copyNotificationCurrentKeyFilter: object

serializedName

serializedName: string = "CopyNotificationCurrentKeyFilter"

type

type: object

name

name: "String" = "String"

copyNotificationCurrentProgress

copyNotificationCurrentProgress: object

serializedName

serializedName: string = "CopyNotificationCurrentProgress"

type

type: object

name

name: "String" = "String"

databaseLogicalSizeEstimate

databaseLogicalSizeEstimate: object

serializedName

serializedName: string = "DatabaseLogicalSizeEstimate"

type

type: object

name

name: "String" = "String"

databaseRowCountEstimate

databaseRowCountEstimate: object

serializedName

serializedName: string = "DatabaseRowCountEstimate"

type

type: object

name

name: "String" = "String"

statusDetails

statusDetails: object

serializedName

serializedName: string = "StatusDetails"

type

type: object

name

name: "String" = "String"

Const LoadMetricInformation

LoadMetricInformation: object

Represents data structure that contains load information for a certain metric in a cluster.

Optional action

action: undefined | string

The current action being taken with regard to this metric

Optional activityThreshold

activityThreshold: undefined | string

The Activity Threshold specified for this metric in the system Cluster Manifest.

Optional balancingThreshold

balancingThreshold: undefined | string

The balancing threshold for a certain metric.

Optional bufferedClusterCapacityRemaining

bufferedClusterCapacityRemaining: undefined | string

Remaining capacity in the cluster excluding the reserved space.

Optional clusterBufferedCapacity

clusterBufferedCapacity: undefined | string

Remaining capacity in the cluster excluding the reserved space. In future releases of Service Fabric this parameter will be deprecated in favor of BufferedClusterCapacityRemaining.

Optional clusterCapacity

clusterCapacity: undefined | string

The total cluster capacity for a given metric

Optional clusterCapacityRemaining

clusterCapacityRemaining: undefined | string

The remaining capacity for the metric in the cluster.

Optional clusterLoad

clusterLoad: undefined | string

The total cluster load. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentClusterLoad.

Optional clusterRemainingBufferedCapacity

clusterRemainingBufferedCapacity: undefined | string

The remaining percentage of cluster total capacity for this metric.

Optional clusterRemainingCapacity

clusterRemainingCapacity: undefined | string

The remaining capacity for the metric in the cluster. In future releases of Service Fabric this parameter will be deprecated in favor of ClusterCapacityRemaining.

Optional currentClusterLoad

currentClusterLoad: undefined | string

The total cluster load.

Optional deviationAfter

deviationAfter: undefined | string

The standard average deviation of the metrics after resource balancer run.

Optional deviationBefore

deviationBefore: undefined | string

The standard average deviation of the metrics before resource balancer run.

Optional isBalancedAfter

isBalancedAfter: undefined | false | true

Value that indicates whether the metrics is balanced or not after resource balancer run.

Optional isBalancedBefore

isBalancedBefore: undefined | false | true

Value that indicates whether the metrics is balanced or not before resource balancer run

Optional isClusterCapacityViolation

isClusterCapacityViolation: undefined | false | true

Indicates that the metric is currently over capacity in the cluster.

Optional maxNodeLoadNodeId

maxNodeLoadNodeId: NodeId

The node id of the node with the maximum load for this metric.

Optional maxNodeLoadValue

maxNodeLoadValue: undefined | string

The maximum load on any node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of MaximumNodeLoad.

Optional maximumNodeLoad

maximumNodeLoad: undefined | string

The maximum load on any node for this metric.

Optional minNodeLoadNodeId

minNodeLoadNodeId: NodeId

The node id of the node with the minimum load for this metric.

Optional minNodeLoadValue

minNodeLoadValue: undefined | string

The minimum load on any node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of MinimumNodeLoad.

Optional minimumNodeLoad

minimumNodeLoad: undefined | string

The minimum load on any node for this metric.

Optional name

name: undefined | string

Name of the metric for which this load information is provided.

Optional nodeBufferPercentage

nodeBufferPercentage: undefined | string

The reserved percentage of total node capacity for this metric.

Optional plannedLoadRemoval

plannedLoadRemoval: undefined | string

This value represents the load of the replicas that are planned to be removed in the future within the cluster. This kind of load is reported for replicas that are currently being moving to other nodes and for replicas that are currently being dropped but still use the load on the source node.

serializedName

serializedName: string = "LoadMetricInformation"

type

type: object

className

className: string = "LoadMetricInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

action

action: object

serializedName

serializedName: string = "Action"

type

type: object

name

name: "String" = "String"

activityThreshold

activityThreshold: object

serializedName

serializedName: string = "ActivityThreshold"

type

type: object

name

name: "String" = "String"

balancingThreshold

balancingThreshold: object

serializedName

serializedName: string = "BalancingThreshold"

type

type: object

name

name: "String" = "String"

bufferedClusterCapacityRemaining

bufferedClusterCapacityRemaining: object

serializedName

serializedName: string = "BufferedClusterCapacityRemaining"

type

type: object

name

name: "String" = "String"

clusterBufferedCapacity

clusterBufferedCapacity: object

serializedName

serializedName: string = "ClusterBufferedCapacity"

type

type: object

name

name: "String" = "String"

clusterCapacity

clusterCapacity: object

serializedName

serializedName: string = "ClusterCapacity"

type

type: object

name

name: "String" = "String"

clusterCapacityRemaining

clusterCapacityRemaining: object

serializedName

serializedName: string = "ClusterCapacityRemaining"

type

type: object

name

name: "String" = "String"

clusterLoad

clusterLoad: object

serializedName

serializedName: string = "ClusterLoad"

type

type: object

name

name: "String" = "String"

clusterRemainingBufferedCapacity

clusterRemainingBufferedCapacity: object

serializedName

serializedName: string = "ClusterRemainingBufferedCapacity"

type

type: object

name

name: "String" = "String"

clusterRemainingCapacity

clusterRemainingCapacity: object

serializedName

serializedName: string = "ClusterRemainingCapacity"

type

type: object

name

name: "String" = "String"

currentClusterLoad

currentClusterLoad: object

serializedName

serializedName: string = "CurrentClusterLoad"

type

type: object

name

name: "String" = "String"

deviationAfter

deviationAfter: object

serializedName

serializedName: string = "DeviationAfter"

type

type: object

name

name: "String" = "String"

deviationBefore

deviationBefore: object

serializedName

serializedName: string = "DeviationBefore"

type

type: object

name

name: "String" = "String"

isBalancedAfter

isBalancedAfter: object

serializedName

serializedName: string = "IsBalancedAfter"

type

type: object

name

name: "Boolean" = "Boolean"

isBalancedBefore

isBalancedBefore: object

serializedName

serializedName: string = "IsBalancedBefore"

type

type: object

name

name: "Boolean" = "Boolean"

isClusterCapacityViolation

isClusterCapacityViolation: object

serializedName

serializedName: string = "IsClusterCapacityViolation"

type

type: object

name

name: "Boolean" = "Boolean"

maxNodeLoadNodeId

maxNodeLoadNodeId: object

serializedName

serializedName: string = "MaxNodeLoadNodeId"

type

type: object

className

className: string = "NodeId"

name

name: "Composite" = "Composite"

maxNodeLoadValue

maxNodeLoadValue: object

serializedName

serializedName: string = "MaxNodeLoadValue"

type

type: object

name

name: "String" = "String"

maximumNodeLoad

maximumNodeLoad: object

serializedName

serializedName: string = "MaximumNodeLoad"

type

type: object

name

name: "String" = "String"

minNodeLoadNodeId

minNodeLoadNodeId: object

serializedName

serializedName: string = "MinNodeLoadNodeId"

type

type: object

className

className: string = "NodeId"

name

name: "Composite" = "Composite"

minNodeLoadValue

minNodeLoadValue: object

serializedName

serializedName: string = "MinNodeLoadValue"

type

type: object

name

name: "String" = "String"

minimumNodeLoad

minimumNodeLoad: object

serializedName

serializedName: string = "MinimumNodeLoad"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

nodeBufferPercentage

nodeBufferPercentage: object

serializedName

serializedName: string = "NodeBufferPercentage"

type

type: object

name

name: "String" = "String"

plannedLoadRemoval

plannedLoadRemoval: object

serializedName

serializedName: string = "PlannedLoadRemoval"

type

type: object

name

name: "String" = "String"

Const LoadMetricReport

LoadMetricReport: object

Represents the load metric report which contains the time metric was reported, its name and value.

Optional currentValue

currentValue: undefined | string

The value of the load metric.

Optional lastReportedUtc

lastReportedUtc: Date

Gets the UTC time when the load was reported.

Optional name

name: undefined | string

The name of the load metric.

Optional value

value: undefined | string

The value of the load metric. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentValue.

serializedName

serializedName: string = "LoadMetricReport"

type

type: object

className

className: string = "LoadMetricReport"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

currentValue

currentValue: object

serializedName

serializedName: string = "CurrentValue"

type

type: object

name

name: "String" = "String"

lastReportedUtc

lastReportedUtc: object

serializedName

serializedName: string = "LastReportedUtc"

type

type: object

name

name: "DateTime" = "DateTime"

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "Value"

type

type: object

name

name: "String" = "String"

Const LoadMetricReportInfo

LoadMetricReportInfo: object

Information about load reported by replica.

Optional currentValue

currentValue: undefined | string

The double value of the load for the metric.

Optional lastReportedUtc

lastReportedUtc: Date

The UTC time when the load is reported.

Optional name

name: undefined | string

The name of the metric.

Optional value

value: undefined | number

The value of the load for the metric. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentValue.

serializedName

serializedName: string = "LoadMetricReportInfo"

type

type: object

className

className: string = "LoadMetricReportInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

currentValue

currentValue: object

serializedName

serializedName: string = "CurrentValue"

type

type: object

name

name: "String" = "String"

lastReportedUtc

lastReportedUtc: object

serializedName

serializedName: string = "LastReportedUtc"

type

type: object

name

name: "DateTime" = "DateTime"

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "Value"

type

type: object

name

name: "Number" = "Number"

Const LocalNetworkResourceProperties

LocalNetworkResourceProperties: object

Information about a Service Fabric container network local to a single Service Fabric cluster.

Optional description

description: undefined | string

User readable description of the network.

kind

kind: "Local"

Polymorphic Discriminator

Optional networkAddressPrefix

networkAddressPrefix: undefined | string

Address space for the local container network.

Optional status

Status of the network. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional statusDetails

statusDetails: undefined | string

Gives additional information about the current status of the network. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Local"

type

type: object

className

className: string = "LocalNetworkResourceProperties"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = NetworkResourcePropertiesBase.type.polymorphicDiscriminator

uberParent

uberParent: string = "NetworkResourcePropertiesBase"

modelProperties

modelProperties: object

networkAddressPrefix

networkAddressPrefix: object

serializedName

serializedName: string = "networkAddressPrefix"

type

type: object

name

name: "String" = "String"

Const ManagedApplicationIdentity

ManagedApplicationIdentity: object

Describes a managed application identity.

name

name: string

The name of the identity.

Optional principalId

principalId: undefined | string

The identity's PrincipalId.

serializedName

serializedName: string = "ManagedApplicationIdentity"

type

type: object

className

className: string = "ManagedApplicationIdentity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

principalId

principalId: object

serializedName

serializedName: string = "PrincipalId"

type

type: object

name

name: "String" = "String"

Const ManagedApplicationIdentityDescription

ManagedApplicationIdentityDescription: object

Managed application identity description.

Optional managedIdentities

managedIdentities: ManagedApplicationIdentity[]

A list of managed application identity objects.

Optional tokenServiceEndpoint

tokenServiceEndpoint: undefined | string

Token service endpoint.

serializedName

serializedName: string = "ManagedApplicationIdentityDescription"

type

type: object

className

className: string = "ManagedApplicationIdentityDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

managedIdentities

managedIdentities: object

serializedName

serializedName: string = "ManagedIdentities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ManagedApplicationIdentity"

name

name: "Composite" = "Composite"

tokenServiceEndpoint

tokenServiceEndpoint: object

serializedName

serializedName: string = "TokenServiceEndpoint"

type

type: object

name

name: "String" = "String"

Const MonitoringPolicyDescription

MonitoringPolicyDescription: object

Describes the parameters for monitoring an upgrade in Monitored mode.

Optional failureAction

failureAction: FailureAction

The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. Possible values include: 'Invalid', 'Rollback', 'Manual'

Optional healthCheckRetryTimeoutInMilliseconds

healthCheckRetryTimeoutInMilliseconds: undefined | string

The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

Optional healthCheckStableDurationInMilliseconds

healthCheckStableDurationInMilliseconds: undefined | string

The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

Optional healthCheckWaitDurationInMilliseconds

healthCheckWaitDurationInMilliseconds: undefined | string

The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

Optional upgradeDomainTimeoutInMilliseconds

upgradeDomainTimeoutInMilliseconds: undefined | string

The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

Optional upgradeTimeoutInMilliseconds

upgradeTimeoutInMilliseconds: undefined | string

The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

serializedName

serializedName: string = "MonitoringPolicyDescription"

type

type: object

className

className: string = "MonitoringPolicyDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

failureAction

failureAction: object

serializedName

serializedName: string = "FailureAction"

type

type: object

name

name: "String" = "String"

healthCheckRetryTimeoutInMilliseconds

healthCheckRetryTimeoutInMilliseconds: object

serializedName

serializedName: string = "HealthCheckRetryTimeoutInMilliseconds"

type

type: object

name

name: "String" = "String"

healthCheckStableDurationInMilliseconds

healthCheckStableDurationInMilliseconds: object

serializedName

serializedName: string = "HealthCheckStableDurationInMilliseconds"

type

type: object

name

name: "String" = "String"

healthCheckWaitDurationInMilliseconds

healthCheckWaitDurationInMilliseconds: object

serializedName

serializedName: string = "HealthCheckWaitDurationInMilliseconds"

type

type: object

name

name: "String" = "String"

upgradeDomainTimeoutInMilliseconds

upgradeDomainTimeoutInMilliseconds: object

serializedName

serializedName: string = "UpgradeDomainTimeoutInMilliseconds"

type

type: object

name

name: "String" = "String"

upgradeTimeoutInMilliseconds

upgradeTimeoutInMilliseconds: object

serializedName

serializedName: string = "UpgradeTimeoutInMilliseconds"

type

type: object

name

name: "String" = "String"

Const NameDescription

NameDescription: object

Describes a Service Fabric name.

name

name: string

The Service Fabric name, including the 'fabric:' URI scheme.

serializedName

serializedName: string = "NameDescription"

type

type: object

className

className: string = "NameDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

Const NamedPartitionInformation

NamedPartitionInformation: object

Describes the partition information for the name as a string that is based on partition schemes.

Optional id

id: undefined | string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

Optional name

name: undefined | string

Name of the partition.

servicePartitionKind

servicePartitionKind: "Named"

Polymorphic Discriminator

serializedName

serializedName: string = "Named"

type

type: object

className

className: string = "NamedPartitionInformation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PartitionInformation.type.polymorphicDiscriminator

uberParent

uberParent: string = "PartitionInformation"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

Const NamedPartitionSchemeDescription

NamedPartitionSchemeDescription: object

Describes the named partition scheme of the service.

count

count: number

The number of partitions.

names

names: string[]

Array of size specified by the ‘Count’ parameter, for the names of the partitions.

partitionScheme

partitionScheme: "Named"

Polymorphic Discriminator

serializedName

serializedName: string = "Named"

type

type: object

className

className: string = "NamedPartitionSchemeDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PartitionSchemeDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "PartitionSchemeDescription"

modelProperties

modelProperties: object

count

count: object

required

required: true = true

serializedName

serializedName: string = "Count"

type

type: object

name

name: "Number" = "Number"

names

names: object

required

required: true = true

serializedName

serializedName: string = "Names"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const NetworkRef

NetworkRef: object

Describes a network reference in a service.

Optional endpointRefs

endpointRefs: EndpointRef[]

A list of endpoints that are exposed on this network.

Optional name

name: undefined | string

Name of the network

serializedName

serializedName: string = "NetworkRef"

type

type: object

className

className: string = "NetworkRef"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endpointRefs

endpointRefs: object

serializedName

serializedName: string = "endpointRefs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EndpointRef"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const NetworkResourceDescription

NetworkResourceDescription: object

This type describes a network resource.

name

name: string

Name of the Network resource.

properties

Describes properties of a network resource.

serializedName

serializedName: string = "NetworkResourceDescription"

type

type: object

className

className: string = "NetworkResourceDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

properties

properties: object

required

required: true = true

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "NetworkResourceProperties"

name

name: "Composite" = "Composite"

Const NetworkResourceProperties

NetworkResourceProperties: object

Describes properties of a network resource.

Optional description

description: undefined | string

User readable description of the network.

kind

kind: "NetworkResourceProperties"

Polymorphic Discriminator

Optional status

Status of the network. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional statusDetails

statusDetails: undefined | string

Gives additional information about the current status of the network. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "NetworkResourceProperties"

type

type: object

className

className: string = "NetworkResourceProperties"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = NetworkResourcePropertiesBase.type.polymorphicDiscriminator

uberParent

uberParent: string = "NetworkResourcePropertiesBase"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

statusDetails

statusDetails: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "statusDetails"

type

type: object

name

name: "String" = "String"

Const NetworkResourcePropertiesBase

NetworkResourcePropertiesBase: object

This type describes the properties of a network resource, including its kind.

kind

kind: "NetworkResourcePropertiesBase"

Polymorphic Discriminator

serializedName

serializedName: string = "NetworkResourcePropertiesBase"

type

type: object

className

className: string = "NetworkResourcePropertiesBase"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "NetworkResourcePropertiesBase"

modelProperties

modelProperties: object

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "kind"

Const NodeAbortedEvent

NodeAbortedEvent: object

Node Aborted event.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

faultDomain

faultDomain: string

Fault domain of Node.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

hostname

hostname: string

Name of Host.

ipAddressOrFQDN

ipAddressOrFQDN: string

IP address or FQDN.

isSeedNode

isSeedNode: boolean

Indicates if it is seed node.

kind

kind: "NodeAborted"

Polymorphic Discriminator

nodeId

nodeId: string

Id of Node.

nodeInstance

nodeInstance: number

Id of Node instance.

nodeName

nodeName: string

The name of a Service Fabric node.

nodeVersion

nodeVersion: string

Version of Node.

timeStamp

timeStamp: Date

The time event was logged.

upgradeDomain

upgradeDomain: string

Upgrade domain of Node.

serializedName

serializedName: string = "NodeAborted"

type

type: object

className

className: string = "NodeAbortedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

faultDomain

faultDomain: object

required

required: true = true

serializedName

serializedName: string = "FaultDomain"

type

type: object

name

name: "String" = "String"

hostname

hostname: object

required

required: true = true

serializedName

serializedName: string = "Hostname"

type

type: object

name

name: "String" = "String"

ipAddressOrFQDN

ipAddressOrFQDN: object

required

required: true = true

serializedName

serializedName: string = "IpAddressOrFQDN"

type

type: object

name

name: "String" = "String"

isSeedNode

isSeedNode: object

required

required: true = true

serializedName

serializedName: string = "IsSeedNode"

type

type: object

name

name: "Boolean" = "Boolean"

nodeId

nodeId: object

required

required: true = true

serializedName

serializedName: string = "NodeId"

type

type: object

name

name: "String" = "String"

nodeInstance

nodeInstance: object

required

required: true = true

serializedName

serializedName: string = "NodeInstance"

type

type: object

name

name: "Number" = "Number"

nodeVersion

nodeVersion: object

required

required: true = true

serializedName

serializedName: string = "NodeVersion"

type

type: object

name

name: "String" = "String"

upgradeDomain

upgradeDomain: object

required

required: true = true

serializedName

serializedName: string = "UpgradeDomain"

type

type: object

name

name: "String" = "String"

Const NodeAddedToClusterEvent

NodeAddedToClusterEvent: object

Node Added event.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

fabricVersion

fabricVersion: string

Fabric version.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

ipAddressOrFQDN

ipAddressOrFQDN: string

IP address or FQDN.

kind

kind: "NodeAddedToCluster"

Polymorphic Discriminator

nodeCapacities

nodeCapacities: string

Capacities.

nodeId

nodeId: string

Id of Node.

nodeInstance

nodeInstance: number

Id of Node instance.

nodeName

nodeName: string

The name of a Service Fabric node.

nodeType

nodeType: string

Type of Node.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "NodeAddedToCluster"

type

type: object

className

className: string = "NodeAddedToClusterEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

fabricVersion

fabricVersion: object

required

required: true = true

serializedName

serializedName: string = "FabricVersion"

type

type: object

name

name: "String" = "String"

ipAddressOrFQDN

ipAddressOrFQDN: object

required

required: true = true

serializedName

serializedName: string = "IpAddressOrFQDN"

type

type: object

name

name: "String" = "String"

nodeCapacities

nodeCapacities: object

required

required: true = true

serializedName

serializedName: string = "NodeCapacities"

type

type: object

name

name: "String" = "String"

nodeId

nodeId: object

required

required: true = true

serializedName

serializedName: string = "NodeId"

type

type: object

name

name: "String" = "String"

nodeInstance

nodeInstance: object

required

required: true = true

serializedName

serializedName: string = "NodeInstance"

type

type: object

name

name: "Number" = "Number"

nodeType

nodeType: object

required

required: true = true

serializedName

serializedName: string = "NodeType"

type

type: object

name

name: "String" = "String"

Const NodeClosedEvent

NodeClosedEvent: object

Node Closed event.

Optional category

category: undefined | string

The category of event.

error

error: string

Describes error.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "NodeClosed"

Polymorphic Discriminator

nodeId

nodeId: string

Id of Node.

nodeInstance

nodeInstance: number

Id of Node instance.

nodeName

nodeName: string

The name of a Service Fabric node.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "NodeClosed"

type

type: object

className

className: string = "NodeClosedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

error

error: object

required

required: true = true

serializedName

serializedName: string = "Error"

type

type: object

name

name: "String" = "String"

nodeId

nodeId: object

required

required: true = true

serializedName

serializedName: string = "NodeId"

type

type: object

name

name: "String" = "String"

nodeInstance

nodeInstance: object

required

required: true = true

serializedName

serializedName: string = "NodeInstance"

type

type: object

name

name: "Number" = "Number"

Const NodeDeactivateCompletedEvent

NodeDeactivateCompletedEvent: object

Node Deactivate Completed event.

batchIdsWithDeactivateIntent

batchIdsWithDeactivateIntent: string

Batch Ids.

Optional category

category: undefined | string

The category of event.

effectiveDeactivateIntent

effectiveDeactivateIntent: string

Describes deactivate intent.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "NodeDeactivateCompleted"

Polymorphic Discriminator

nodeInstance

nodeInstance: number

Id of Node instance.

nodeName

nodeName: string

The name of a Service Fabric node.

startTime

startTime: Date

Start time.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "NodeDeactivateCompleted"

type

type: object

className

className: string = "NodeDeactivateCompletedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

batchIdsWithDeactivateIntent

batchIdsWithDeactivateIntent: object

required

required: true = true

serializedName

serializedName: string = "BatchIdsWithDeactivateIntent"

type

type: object

name

name: "String" = "String"

effectiveDeactivateIntent

effectiveDeactivateIntent: object

required

required: true = true

serializedName

serializedName: string = "EffectiveDeactivateIntent"

type

type: object

name

name: "String" = "String"

nodeInstance

nodeInstance: object

required

required: true = true

serializedName

serializedName: string = "NodeInstance"

type

type: object

name

name: "Number" = "Number"

startTime

startTime: object

required

required: true = true

serializedName

serializedName: string = "StartTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const NodeDeactivateStartedEvent

NodeDeactivateStartedEvent: object

Node Deactivate Started event.

batchId

batchId: string

Batch Id.

Optional category

category: undefined | string

The category of event.

deactivateIntent

deactivateIntent: string

Describes deactivate intent.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "NodeDeactivateStarted"

Polymorphic Discriminator

nodeInstance

nodeInstance: number

Id of Node instance.

nodeName

nodeName: string

The name of a Service Fabric node.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "NodeDeactivateStarted"

type

type: object

className

className: string = "NodeDeactivateStartedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

batchId

batchId: object

required

required: true = true

serializedName

serializedName: string = "BatchId"

type

type: object

name

name: "String" = "String"

deactivateIntent

deactivateIntent: object

required

required: true = true

serializedName

serializedName: string = "DeactivateIntent"

type

type: object

name

name: "String" = "String"

nodeInstance

nodeInstance: object

required

required: true = true

serializedName

serializedName: string = "NodeInstance"

type

type: object

name

name: "Number" = "Number"

Const NodeDeactivationInfo

NodeDeactivationInfo: object

Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated.

Optional nodeDeactivationIntent

nodeDeactivationIntent: NodeDeactivationIntent

The intent or the reason for deactivating the node. Following are the possible values for it. Possible values include: 'Invalid', 'Pause', 'Restart', 'RemoveData', 'RemoveNode'

Optional nodeDeactivationStatus

nodeDeactivationStatus: NodeDeactivationStatus

The status of node deactivation operation. Following are the possible values. Possible values include: 'None', 'SafetyCheckInProgress', 'SafetyCheckComplete', 'Completed'

Optional nodeDeactivationTask

nodeDeactivationTask: NodeDeactivationTask[]

List of tasks representing the deactivation operation on the node.

Optional pendingSafetyChecks

pendingSafetyChecks: SafetyCheckWrapper[]

List of pending safety checks

serializedName

serializedName: string = "NodeDeactivationInfo"

type

type: object

className

className: string = "NodeDeactivationInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nodeDeactivationIntent

nodeDeactivationIntent: object

serializedName

serializedName: string = "NodeDeactivationIntent"

type

type: object

name

name: "String" = "String"

nodeDeactivationStatus

nodeDeactivationStatus: object

serializedName

serializedName: string = "NodeDeactivationStatus"

type

type: object

name

name: "String" = "String"

nodeDeactivationTask

nodeDeactivationTask: object

serializedName

serializedName: string = "NodeDeactivationTask"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NodeDeactivationTask"

name

name: "Composite" = "Composite"

pendingSafetyChecks

pendingSafetyChecks: object

serializedName

serializedName: string = "PendingSafetyChecks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SafetyCheckWrapper"

name

name: "Composite" = "Composite"

Const NodeDeactivationTask

NodeDeactivationTask: object

The task representing the deactivation operation on the node.

Optional nodeDeactivationIntent

nodeDeactivationIntent: NodeDeactivationIntent

The intent or the reason for deactivating the node. Following are the possible values for it. Possible values include: 'Invalid', 'Pause', 'Restart', 'RemoveData', 'RemoveNode'

Optional nodeDeactivationTaskId

nodeDeactivationTaskId: NodeDeactivationTaskId

Identity of the task related to deactivation operation on the node.

serializedName

serializedName: string = "NodeDeactivationTask"

type

type: object

className

className: string = "NodeDeactivationTask"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nodeDeactivationIntent

nodeDeactivationIntent: object

serializedName

serializedName: string = "NodeDeactivationIntent"

type

type: object

name

name: "String" = "String"

nodeDeactivationTaskId

nodeDeactivationTaskId: object

serializedName

serializedName: string = "NodeDeactivationTaskId"

type

type: object

className

className: string = "NodeDeactivationTaskId"

name

name: "Composite" = "Composite"

Const NodeDeactivationTaskId

NodeDeactivationTaskId: object

Identity of the task related to deactivation operation on the node.

Optional id

id: undefined | string

Value of the task id.

Optional nodeDeactivationTaskType

nodeDeactivationTaskType: NodeDeactivationTaskType

The type of the task that performed the node deactivation. Following are the possible values. Possible values include: 'Invalid', 'Infrastructure', 'Repair', 'Client'

serializedName

serializedName: string = "NodeDeactivationTaskId"

type

type: object

className

className: string = "NodeDeactivationTaskId"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "Id"

type

type: object

name

name: "String" = "String"

nodeDeactivationTaskType

nodeDeactivationTaskType: object

serializedName

serializedName: string = "NodeDeactivationTaskType"

type

type: object

name

name: "String" = "String"

Const NodeDownEvent

NodeDownEvent: object

Node Down event.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "NodeDown"

Polymorphic Discriminator

lastNodeUpAt

lastNodeUpAt: Date

Time when Node was last up.

nodeInstance

nodeInstance: number

Id of Node instance.

nodeName

nodeName: string

The name of a Service Fabric node.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "NodeDown"

type

type: object

className

className: string = "NodeDownEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

lastNodeUpAt

lastNodeUpAt: object

required

required: true = true

serializedName

serializedName: string = "LastNodeUpAt"

type

type: object

name

name: "DateTime" = "DateTime"

nodeInstance

nodeInstance: object

required

required: true = true

serializedName

serializedName: string = "NodeInstance"

type

type: object

name

name: "Number" = "Number"

Const NodeEvent

NodeEvent: object

Represents the base for all Node Events.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "NodeEvent"

Polymorphic Discriminator

nodeName

nodeName: string

The name of a Service Fabric node.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "NodeEvent"

type

type: object

className

className: string = "NodeEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

nodeName

nodeName: object

required

required: true = true

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

Const NodeHealth

NodeHealth: object

Information about the health of a Service Fabric node.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional healthEvents

healthEvents: HealthEvent[]

The list of health events reported on the entity.

Optional healthStatistics

healthStatistics: HealthStatistics

Shows the health statistics for all children types of the queried entity.

Optional name

name: undefined | string

Name of the node whose health information is described by this object.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.

serializedName

serializedName: string = "NodeHealth"

type

type: object

className

className: string = "NodeHealth"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

Const NodeHealthEvaluation

NodeHealthEvaluation: object

Represents health evaluation for a node, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional description

description: undefined | string

Description of the health evaluation, which represents a summary of the evaluation process.

kind

kind: "Node"

Polymorphic Discriminator

Optional nodeName

nodeName: undefined | string

The name of a Service Fabric node.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

List of unhealthy evaluations that led to the current aggregated health state of the node. The types of the unhealthy evaluations can be EventHealthEvaluation.

serializedName

serializedName: string = "Node"

type

type: object

className

className: string = "NodeHealthEvaluation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = HealthEvaluation.type.polymorphicDiscriminator

uberParent

uberParent: string = "HealthEvaluation"

modelProperties

modelProperties: object

nodeName

nodeName: object

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

Const NodeHealthReportExpiredEvent

NodeHealthReportExpiredEvent: object

Node Health Report Expired event.

Optional category

category: undefined | string

The category of event.

description

description: string

Description of report.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

healthState

healthState: string

Describes the property health state.

kind

kind: "NodeHealthReportExpired"

Polymorphic Discriminator

nodeInstanceId

nodeInstanceId: number

Id of Node instance.

nodeName

nodeName: string

The name of a Service Fabric node.

property

property: string

Describes the property.

removeWhenExpired

removeWhenExpired: boolean

Indicates the removal when it expires.

sequenceNumber

sequenceNumber: number

Sequence number of report.

sourceId

sourceId: string

Id of report source.

sourceUtcTimestamp

sourceUtcTimestamp: Date

Source time.

timeStamp

timeStamp: Date

The time event was logged.

timeToLiveMs

timeToLiveMs: number

Time to live in milli-seconds.

serializedName

serializedName: string = "NodeHealthReportExpired"

type

type: object

className

className: string = "NodeHealthReportExpiredEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

description

description: object

required

required: true = true

serializedName

serializedName: string = "Description"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

required

required: true = true

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

nodeInstanceId

nodeInstanceId: object

required

required: true = true

serializedName

serializedName: string = "NodeInstanceId"

type

type: object

name

name: "Number" = "Number"

property

property: object

required

required: true = true

serializedName

serializedName: string = "Property"

type

type: object

name

name: "String" = "String"

removeWhenExpired

removeWhenExpired: object

required

required: true = true

serializedName

serializedName: string = "RemoveWhenExpired"

type

type: object

name

name: "Boolean" = "Boolean"

sequenceNumber

sequenceNumber: object

required

required: true = true

serializedName

serializedName: string = "SequenceNumber"

type

type: object

name

name: "Number" = "Number"

sourceId

sourceId: object

required

required: true = true

serializedName

serializedName: string = "SourceId"

type

type: object

name

name: "String" = "String"

sourceUtcTimestamp

sourceUtcTimestamp: object

required

required: true = true

serializedName

serializedName: string = "SourceUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

timeToLiveMs

timeToLiveMs: object

required

required: true = true

serializedName

serializedName: string = "TimeToLiveMs"

type

type: object

name

name: "Number" = "Number"

Const NodeHealthState

NodeHealthState: object

Represents the health state of a node, which contains the node identifier and its aggregated health state.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional id

id: NodeId

An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.

Optional name

name: undefined | string

The name of a Service Fabric node.

serializedName

serializedName: string = "NodeHealthState"

type

type: object

className

className: string = "NodeHealthState"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "Id"

type

type: object

className

className: string = "NodeId"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

Const NodeHealthStateChunk

NodeHealthStateChunk: object

Represents the health state chunk of a node, which contains the node name and its aggregated health state.

Optional healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional nodeName

nodeName: undefined | string

The name of a Service Fabric node.

serializedName

serializedName: string = "NodeHealthStateChunk"

type

type: object

className

className: string = "NodeHealthStateChunk"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nodeName

nodeName: object

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

Const NodeHealthStateChunkList

NodeHealthStateChunkList: object

The list of node health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.

Optional items

The list of node health state chunks that respect the input filters in the chunk query.

Optional totalCount

totalCount: undefined | number

Total number of entity health state objects that match the specified filters from the cluster health chunk query description.

serializedName

serializedName: string = "NodeHealthStateChunkList"

type

type: object

className

className: string = "NodeHealthStateChunkList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NodeHealthStateChunk"

name

name: "Composite" = "Composite"

Const NodeHealthStateFilter

NodeHealthStateFilter: object

Defines matching criteria to determine whether a node should be included in the returned cluster health chunk. One filter can match zero, one or multiple nodes, depending on its properties. Can be specified in the cluster health chunk query description.

Optional healthStateFilter

healthStateFilter: undefined | number

The filter for the health state of the nodes. It allows selecting nodes if they match the desired health states. The possible values are integer value of one of the following health states. Only nodes that match the filter are returned. All nodes are used to evaluate the cluster aggregated health state. If not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching node is returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6, it matches nodes with HealthState value of OK (2) and Warning (4).

  • Default - Default value. Matches any HealthState. The value is zero.
  • None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.
  • Ok - Filter that matches input with HealthState value Ok. The value is 2.
  • Warning - Filter that matches input with HealthState value Warning. The value is 4.
  • Error - Filter that matches input with HealthState value Error. The value is 8.
  • All - Filter that matches input with any HealthState value. The value is 65535. Default value: 0.

Optional nodeNameFilter

nodeNameFilter: undefined | string

Name of the node that matches the filter. The filter is applied only to the specified node, if it exists. If the node doesn't exist, no node is returned in the cluster health chunk based on this filter. If the node exists, it is included in the cluster health chunk if the health state matches the other filter properties. If not specified, all nodes that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.

serializedName

serializedName: string = "NodeHealthStateFilter"

type

type: object

className

className: string = "NodeHealthStateFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

healthStateFilter

healthStateFilter: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "HealthStateFilter"

type

type: object

name

name: "Number" = "Number"

nodeNameFilter

nodeNameFilter: object

serializedName

serializedName: string = "NodeNameFilter"

type

type: object

name

name: "String" = "String"

Const NodeId

NodeId: object

An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.

Optional id

id: undefined | string

Value of the node Id. This is a 128 bit integer.

serializedName

serializedName: string = "NodeId"

type

type: object

className

className: string = "NodeId"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "Id"

type

type: object

name

name: "String" = "String"

Const NodeImpact

NodeImpact: object

Describes the expected impact of a repair to a particular node.

This type supports the Service Fabric platform; it is not meant to be used directly from your code.

Optional impactLevel

impactLevel: ImpactLevel

The level of impact expected. Possible values include: 'Invalid', 'None', 'Restart', 'RemoveData', 'RemoveNode'

nodeName

nodeName: string

The name of the impacted node.

serializedName

serializedName: string = "NodeImpact"

type

type: object

className

className: string = "NodeImpact"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

impactLevel

impactLevel: object

serializedName

serializedName: string = "ImpactLevel"

type

type: object

name

name: "String" = "String"

nodeName

nodeName: object

required

required: true = true

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

Const NodeInfo

NodeInfo: object

Information about a node in Service Fabric cluster.

Optional codeVersion

codeVersion: undefined | string

The version of Service Fabric binaries that the node is running.

Optional configVersion

configVersion: undefined | string

The version of Service Fabric cluster manifest that the node is using.

Optional faultDomain

faultDomain: undefined | string

The fault domain of the node.

Optional healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional id

id: NodeId

An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.

Optional instanceId

instanceId: undefined | string

The ID representing the node instance. While the ID of the node is deterministically generated from the node name and remains same across restarts, the InstanceId changes every time node restarts.

Optional ipAddressOrFQDN

ipAddressOrFQDN: undefined | string

The IP address or fully qualified domain name of the node.

Optional isSeedNode

isSeedNode: undefined | false | true

Indicates if the node is a seed node or not. Returns true if the node is a seed node, otherwise false. A quorum of seed nodes are required for proper operation of Service Fabric cluster.

Optional isStopped

isStopped: undefined | false | true

Indicates if the node is stopped by calling stop node API or not. Returns true if the node is stopped, otherwise false.

Optional name

name: undefined | string

The name of a Service Fabric node.

Optional nodeDeactivationInfo

nodeDeactivationInfo: NodeDeactivationInfo

Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated.

Optional nodeDownAt

nodeDownAt: Date

Date time in UTC when the node went down. If node has never been down then this value will be zero date time.

Optional nodeDownTimeInSeconds

nodeDownTimeInSeconds: undefined | string

Time in seconds since the node has been in NodeStatus Down. Value zero indicates node is not NodeStatus Down.

Optional nodeStatus

nodeStatus: NodeStatus

The status of the node. Possible values include: 'Invalid', 'Up', 'Down', 'Enabling', 'Disabling', 'Disabled', 'Unknown', 'Removed'

Optional nodeUpAt

nodeUpAt: Date

Date time in UTC when the node came up. If the node has never been up then this value will be zero date time.

Optional nodeUpTimeInSeconds

nodeUpTimeInSeconds: undefined | string

Time in seconds since the node has been in NodeStatus Up. Value zero indicates that the node is not Up.

Optional upgradeDomain

upgradeDomain: undefined | string

The upgrade domain of the node.

serializedName

serializedName: string = "NodeInfo"

Optional type

type: object

The type of the node.

className

className: string = "NodeInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

codeVersion

codeVersion: object

serializedName

serializedName: string = "CodeVersion"

type

type: object

name

name: "String" = "String"

configVersion

configVersion: object

serializedName

serializedName: string = "ConfigVersion"

type

type: object

name

name: "String" = "String"

faultDomain

faultDomain: object

serializedName

serializedName: string = "FaultDomain"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

id

id: object

serializedName

serializedName: string = "Id"

type

type: object

className

className: string = "NodeId"

name

name: "Composite" = "Composite"

instanceId

instanceId: object

serializedName

serializedName: string = "InstanceId"

type

type: object

name

name: "String" = "String"

ipAddressOrFQDN

ipAddressOrFQDN: object

serializedName

serializedName: string = "IpAddressOrFQDN"

type

type: object

name

name: "String" = "String"

isSeedNode

isSeedNode: object

serializedName

serializedName: string = "IsSeedNode"

type

type: object

name

name: "Boolean" = "Boolean"

isStopped

isStopped: object

serializedName

serializedName: string = "IsStopped"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

nodeDeactivationInfo

nodeDeactivationInfo: object

serializedName

serializedName: string = "NodeDeactivationInfo"

type

type: object

className

className: string = "NodeDeactivationInfo"

name

name: "Composite" = "Composite"

nodeDownAt

nodeDownAt: object

serializedName

serializedName: string = "NodeDownAt"

type

type: object

name

name: "DateTime" = "DateTime"

nodeDownTimeInSeconds

nodeDownTimeInSeconds: object

serializedName

serializedName: string = "NodeDownTimeInSeconds"

type

type: object

name

name: "String" = "String"

nodeStatus

nodeStatus: object

serializedName

serializedName: string = "NodeStatus"

type

type: object

name

name: "String" = "String"

nodeUpAt

nodeUpAt: object

serializedName

serializedName: string = "NodeUpAt"

type

type: object

name

name: "DateTime" = "DateTime"

nodeUpTimeInSeconds

nodeUpTimeInSeconds: object

serializedName

serializedName: string = "NodeUpTimeInSeconds"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "Type"

type

type: object

name

name: "String" = "String"

upgradeDomain

upgradeDomain: object

serializedName

serializedName: string = "UpgradeDomain"

type

type: object

name

name: "String" = "String"

Const NodeLoadInfo

NodeLoadInfo: object

Information about load on a Service Fabric node. It holds a summary of all metrics and their load on a node.

Optional nodeLoadMetricInformation

nodeLoadMetricInformation: NodeLoadMetricInformation[]

List that contains metrics and their load information on this node.

Optional nodeName

nodeName: undefined | string

Name of the node for which the load information is provided by this object.

serializedName

serializedName: string = "NodeLoadInfo"

type

type: object

className

className: string = "NodeLoadInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nodeLoadMetricInformation

nodeLoadMetricInformation: object

serializedName

serializedName: string = "NodeLoadMetricInformation"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NodeLoadMetricInformation"

name

name: "Composite" = "Composite"

nodeName

nodeName: object

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

Const NodeLoadMetricInformation

NodeLoadMetricInformation: object

Represents data structure that contains load information for a certain metric on a node.

Optional bufferedNodeCapacityRemaining

bufferedNodeCapacityRemaining: undefined | string

The remaining capacity which is not reserved by NodeBufferPercentage for this metric on the node.

Optional currentNodeLoad

currentNodeLoad: undefined | string

Current load on the node for this metric.

Optional isCapacityViolation

isCapacityViolation: undefined | false | true

Indicates if there is a capacity violation for this metric on the node.

Optional name

name: undefined | string

Name of the metric for which this load information is provided.

Optional nodeBufferedCapacity

nodeBufferedCapacity: undefined | string

The value that indicates the reserved capacity for this metric on the node.

Optional nodeCapacity

nodeCapacity: undefined | string

Total capacity on the node for this metric.

Optional nodeCapacityRemaining

nodeCapacityRemaining: undefined | string

The remaining capacity on the node for the metric.

Optional nodeLoad

nodeLoad: undefined | string

Current load on the node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentNodeLoad.

Optional nodeRemainingBufferedCapacity

nodeRemainingBufferedCapacity: undefined | string

The remaining reserved capacity for this metric on the node. In future releases of Service Fabric this parameter will be deprecated in favor of BufferedNodeCapacityRemaining.

Optional nodeRemainingCapacity

nodeRemainingCapacity: undefined | string

The remaining capacity on the node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of NodeCapacityRemaining.

Optional plannedNodeLoadRemoval

plannedNodeLoadRemoval: undefined | string

This value represents the load of the replicas that are planned to be removed in the future. This kind of load is reported for replicas that are currently being moving to other nodes and for replicas that are currently being dropped but still use the load on the source node.

serializedName

serializedName: string = "NodeLoadMetricInformation"

type

type: object

className

className: string = "NodeLoadMetricInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bufferedNodeCapacityRemaining

bufferedNodeCapacityRemaining: object

serializedName

serializedName: string = "BufferedNodeCapacityRemaining"

type

type: object

name

name: "String" = "String"

currentNodeLoad

currentNodeLoad: object

serializedName

serializedName: string = "CurrentNodeLoad"

type

type: object

name

name: "String" = "String"

isCapacityViolation

isCapacityViolation: object

serializedName

serializedName: string = "IsCapacityViolation"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

nodeBufferedCapacity

nodeBufferedCapacity: object

serializedName

serializedName: string = "NodeBufferedCapacity"

type

type: object

name

name: "String" = "String"

nodeCapacity

nodeCapacity: object

serializedName

serializedName: string = "NodeCapacity"

type

type: object

name

name: "String" = "String"

nodeCapacityRemaining

nodeCapacityRemaining: object

serializedName

serializedName: string = "NodeCapacityRemaining"

type

type: object

name

name: "String" = "String"

nodeLoad

nodeLoad: object

serializedName

serializedName: string = "NodeLoad"

type

type: object

name

name: "String" = "String"

nodeRemainingBufferedCapacity

nodeRemainingBufferedCapacity: object

serializedName

serializedName: string = "NodeRemainingBufferedCapacity"

type

type: object

name

name: "String" = "String"

nodeRemainingCapacity

nodeRemainingCapacity: object

serializedName

serializedName: string = "NodeRemainingCapacity"

type

type: object

name

name: "String" = "String"

plannedNodeLoadRemoval

plannedNodeLoadRemoval: object

serializedName

serializedName: string = "PlannedNodeLoadRemoval"

type

type: object

name

name: "String" = "String"

Const NodeNewHealthReportEvent

NodeNewHealthReportEvent: object

Node Health Report Created event.

Optional category

category: undefined | string

The category of event.

description

description: string

Description of report.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

healthState

healthState: string

Describes the property health state.

kind

kind: "NodeNewHealthReport"

Polymorphic Discriminator

nodeInstanceId

nodeInstanceId: number

Id of Node instance.

nodeName

nodeName: string

The name of a Service Fabric node.

property

property: string

Describes the property.

removeWhenExpired

removeWhenExpired: boolean

Indicates the removal when it expires.

sequenceNumber

sequenceNumber: number

Sequence number of report.

sourceId

sourceId: string

Id of report source.

sourceUtcTimestamp

sourceUtcTimestamp: Date

Source time.

timeStamp

timeStamp: Date

The time event was logged.

timeToLiveMs

timeToLiveMs: number

Time to live in milli-seconds.

serializedName

serializedName: string = "NodeNewHealthReport"

type

type: object

className

className: string = "NodeNewHealthReportEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

description

description: object

required

required: true = true

serializedName

serializedName: string = "Description"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

required

required: true = true

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

nodeInstanceId

nodeInstanceId: object

required

required: true = true

serializedName

serializedName: string = "NodeInstanceId"

type

type: object

name

name: "Number" = "Number"

property

property: object

required

required: true = true

serializedName

serializedName: string = "Property"

type

type: object

name

name: "String" = "String"

removeWhenExpired

removeWhenExpired: object

required

required: true = true

serializedName

serializedName: string = "RemoveWhenExpired"

type

type: object

name

name: "Boolean" = "Boolean"

sequenceNumber

sequenceNumber: object

required

required: true = true

serializedName

serializedName: string = "SequenceNumber"

type

type: object

name

name: "Number" = "Number"

sourceId

sourceId: object

required

required: true = true

serializedName

serializedName: string = "SourceId"

type

type: object

name

name: "String" = "String"

sourceUtcTimestamp

sourceUtcTimestamp: object

required

required: true = true

serializedName

serializedName: string = "SourceUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

timeToLiveMs

timeToLiveMs: object

required

required: true = true

serializedName

serializedName: string = "TimeToLiveMs"

type

type: object

name

name: "Number" = "Number"

Const NodeOpenFailedEvent

NodeOpenFailedEvent: object

Node Open Failed event.

Optional category

category: undefined | string

The category of event.

error

error: string

Describes the error.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

faultDomain

faultDomain: string

Fault domain of Node.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

hostname

hostname: string

Name of Host.

ipAddressOrFQDN

ipAddressOrFQDN: string

IP address or FQDN.

isSeedNode

isSeedNode: boolean

Indicates if it is seed node.

kind

kind: "NodeOpenFailed"

Polymorphic Discriminator

nodeId

nodeId: string

Id of Node.

nodeInstance

nodeInstance: number

Id of Node instance.

nodeName

nodeName: string

The name of a Service Fabric node.

nodeVersion

nodeVersion: string

Version of Node.

timeStamp

timeStamp: Date

The time event was logged.

upgradeDomain

upgradeDomain: string

Upgrade domain of Node.

serializedName

serializedName: string = "NodeOpenFailed"

type

type: object

className

className: string = "NodeOpenFailedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

error

error: object

required

required: true = true

serializedName

serializedName: string = "Error"

type

type: object

name

name: "String" = "String"

faultDomain

faultDomain: object

required

required: true = true

serializedName

serializedName: string = "FaultDomain"

type

type: object

name

name: "String" = "String"

hostname

hostname: object

required

required: true = true

serializedName

serializedName: string = "Hostname"

type

type: object

name

name: "String" = "String"

ipAddressOrFQDN

ipAddressOrFQDN: object

required

required: true = true

serializedName

serializedName: string = "IpAddressOrFQDN"

type

type: object

name

name: "String" = "String"

isSeedNode

isSeedNode: object

required

required: true = true

serializedName

serializedName: string = "IsSeedNode"

type

type: object

name

name: "Boolean" = "Boolean"

nodeId

nodeId: object

required

required: true = true

serializedName

serializedName: string = "NodeId"

type

type: object

name

name: "String" = "String"

nodeInstance

nodeInstance: object

required

required: true = true

serializedName

serializedName: string = "NodeInstance"

type

type: object

name

name: "Number" = "Number"

nodeVersion

nodeVersion: object

required

required: true = true

serializedName

serializedName: string = "NodeVersion"

type

type: object

name

name: "String" = "String"

upgradeDomain

upgradeDomain: object

required

required: true = true

serializedName

serializedName: string = "UpgradeDomain"

type

type: object

name

name: "String" = "String"

Const NodeOpenSucceededEvent

NodeOpenSucceededEvent: object

Node Opened Succeeded event.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

faultDomain

faultDomain: string

Fault domain of Node.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

hostname

hostname: string

Name of Host.

ipAddressOrFQDN

ipAddressOrFQDN: string

IP address or FQDN.

isSeedNode

isSeedNode: boolean

Indicates if it is seed node.

kind

kind: "NodeOpenSucceeded"

Polymorphic Discriminator

nodeId

nodeId: string

Id of Node.

nodeInstance

nodeInstance: number

Id of Node instance.

nodeName

nodeName: string

The name of a Service Fabric node.

nodeVersion

nodeVersion: string

Version of Node.

timeStamp

timeStamp: Date

The time event was logged.

upgradeDomain

upgradeDomain: string

Upgrade domain of Node.

serializedName

serializedName: string = "NodeOpenSucceeded"

type

type: object

className

className: string = "NodeOpenSucceededEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

faultDomain

faultDomain: object

required

required: true = true

serializedName

serializedName: string = "FaultDomain"

type

type: object

name

name: "String" = "String"

hostname

hostname: object

required

required: true = true

serializedName

serializedName: string = "Hostname"

type

type: object

name

name: "String" = "String"

ipAddressOrFQDN

ipAddressOrFQDN: object

required

required: true = true

serializedName

serializedName: string = "IpAddressOrFQDN"

type

type: object

name

name: "String" = "String"

isSeedNode

isSeedNode: object

required

required: true = true

serializedName

serializedName: string = "IsSeedNode"

type

type: object

name

name: "Boolean" = "Boolean"

nodeId

nodeId: object

required

required: true = true

serializedName

serializedName: string = "NodeId"

type

type: object

name

name: "String" = "String"

nodeInstance

nodeInstance: object

required

required: true = true

serializedName

serializedName: string = "NodeInstance"

type

type: object

name

name: "Number" = "Number"

nodeVersion

nodeVersion: object

required

required: true = true

serializedName

serializedName: string = "NodeVersion"

type

type: object

name

name: "String" = "String"

upgradeDomain

upgradeDomain: object

required

required: true = true

serializedName

serializedName: string = "UpgradeDomain"

type

type: object

name

name: "String" = "String"

Const NodeRemovedFromClusterEvent

NodeRemovedFromClusterEvent: object

Node Removed event.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

fabricVersion

fabricVersion: string

Fabric version.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

ipAddressOrFQDN

ipAddressOrFQDN: string

IP address or FQDN.

kind

kind: "NodeRemovedFromCluster"

Polymorphic Discriminator

nodeCapacities

nodeCapacities: string

Capacities.

nodeId

nodeId: string

Id of Node.

nodeInstance

nodeInstance: number

Id of Node instance.

nodeName

nodeName: string

The name of a Service Fabric node.

nodeType

nodeType: string

Type of Node.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "NodeRemovedFromCluster"

type

type: object

className

className: string = "NodeRemovedFromClusterEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

fabricVersion

fabricVersion: object

required

required: true = true

serializedName

serializedName: string = "FabricVersion"

type

type: object

name

name: "String" = "String"

ipAddressOrFQDN

ipAddressOrFQDN: object

required

required: true = true

serializedName

serializedName: string = "IpAddressOrFQDN"

type

type: object

name

name: "String" = "String"

nodeCapacities

nodeCapacities: object

required

required: true = true

serializedName

serializedName: string = "NodeCapacities"

type

type: object

name

name: "String" = "String"

nodeId

nodeId: object

required

required: true = true

serializedName

serializedName: string = "NodeId"

type

type: object

name

name: "String" = "String"

nodeInstance

nodeInstance: object

required

required: true = true

serializedName

serializedName: string = "NodeInstance"

type

type: object

name

name: "Number" = "Number"

nodeType

nodeType: object

required

required: true = true

serializedName

serializedName: string = "NodeType"

type

type: object

name

name: "String" = "String"

Const NodeRepairImpactDescription

NodeRepairImpactDescription: object

Describes the expected impact of a repair on a set of nodes.

This type supports the Service Fabric platform; it is not meant to be used directly from your code.

kind

kind: "Node"

Polymorphic Discriminator

Optional nodeImpactList

nodeImpactList: NodeImpact[]

The list of nodes impacted by a repair action and their respective expected impact.

serializedName

serializedName: string = "Node"

type

type: object

className

className: string = "NodeRepairImpactDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RepairImpactDescriptionBase.type.polymorphicDiscriminator

uberParent

uberParent: string = "RepairImpactDescriptionBase"

modelProperties

modelProperties: object

nodeImpactList

nodeImpactList: object

serializedName

serializedName: string = "NodeImpactList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NodeImpact"

name

name: "Composite" = "Composite"

Const NodeRepairTargetDescription

NodeRepairTargetDescription: object

Describes the list of nodes targeted by a repair action.

This type supports the Service Fabric platform; it is not meant to be used directly from your code.

kind

kind: "Node"

Polymorphic Discriminator

Optional nodeNames

nodeNames: string[]

The list of nodes targeted by a repair action.

serializedName

serializedName: string = "Node"

type

type: object

className

className: string = "NodeRepairTargetDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RepairTargetDescriptionBase.type.polymorphicDiscriminator

uberParent

uberParent: string = "RepairTargetDescriptionBase"

modelProperties

modelProperties: object

nodeNames

nodeNames: object

serializedName

serializedName: string = "NodeNames"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const NodeResult

NodeResult: object

Contains information about a node that was targeted by a user-induced operation.

Optional nodeInstanceId

nodeInstanceId: undefined | string

The node instance id.

Optional nodeName

nodeName: undefined | string

The name of a Service Fabric node.

serializedName

serializedName: string = "NodeResult"

type

type: object

className

className: string = "NodeResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nodeInstanceId

nodeInstanceId: object

serializedName

serializedName: string = "NodeInstanceId"

type

type: object

name

name: "String" = "String"

nodeName

nodeName: object

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

Const NodeTransitionProgress

NodeTransitionProgress: object

Information about an NodeTransition operation. This class contains an OperationState and a NodeTransitionResult. The NodeTransitionResult is not valid until OperationState is Completed or Faulted.

Optional nodeTransitionResult

nodeTransitionResult: NodeTransitionResult

Represents information about an operation in a terminal state (Completed or Faulted).

Optional state

The state of the operation. Possible values include: 'Invalid', 'Running', 'RollingBack', 'Completed', 'Faulted', 'Cancelled', 'ForceCancelled'

serializedName

serializedName: string = "NodeTransitionProgress"

type

type: object

className

className: string = "NodeTransitionProgress"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nodeTransitionResult

nodeTransitionResult: object

serializedName

serializedName: string = "NodeTransitionResult"

type

type: object

className

className: string = "NodeTransitionResult"

name

name: "Composite" = "Composite"

state

state: object

serializedName

serializedName: string = "State"

type

type: object

name

name: "String" = "String"

Const NodeTransitionResult

NodeTransitionResult: object

Represents information about an operation in a terminal state (Completed or Faulted).

Optional errorCode

errorCode: undefined | number

If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason.

Optional nodeResult

nodeResult: NodeResult

Contains information about a node that was targeted by a user-induced operation.

serializedName

serializedName: string = "NodeTransitionResult"

type

type: object

className

className: string = "NodeTransitionResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "ErrorCode"

type

type: object

name

name: "Number" = "Number"

nodeResult

nodeResult: object

serializedName

serializedName: string = "NodeResult"

type

type: object

className

className: string = "NodeResult"

name

name: "Composite" = "Composite"

Const NodeUpEvent

NodeUpEvent: object

Node Up event.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "NodeUp"

Polymorphic Discriminator

lastNodeDownAt

lastNodeDownAt: Date

Time when Node was last down.

nodeInstance

nodeInstance: number

Id of Node instance.

nodeName

nodeName: string

The name of a Service Fabric node.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "NodeUp"

type

type: object

className

className: string = "NodeUpEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

lastNodeDownAt

lastNodeDownAt: object

required

required: true = true

serializedName

serializedName: string = "LastNodeDownAt"

type

type: object

name

name: "DateTime" = "DateTime"

nodeInstance

nodeInstance: object

required

required: true = true

serializedName

serializedName: string = "NodeInstance"

type

type: object

name

name: "Number" = "Number"

Const NodeUpgradeProgressInfo

NodeUpgradeProgressInfo: object

Information about the upgrading node and its status

Optional nodeName

nodeName: undefined | string

The name of a Service Fabric node.

Optional pendingSafetyChecks

pendingSafetyChecks: SafetyCheckWrapper[]

List of pending safety checks

Optional upgradePhase

upgradePhase: NodeUpgradePhase

The state of the upgrading node. Possible values include: 'Invalid', 'PreUpgradeSafetyCheck', 'Upgrading', 'PostUpgradeSafetyCheck'

serializedName

serializedName: string = "NodeUpgradeProgressInfo"

type

type: object

className

className: string = "NodeUpgradeProgressInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nodeName

nodeName: object

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

pendingSafetyChecks

pendingSafetyChecks: object

serializedName

serializedName: string = "PendingSafetyChecks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SafetyCheckWrapper"

name

name: "Composite" = "Composite"

upgradePhase

upgradePhase: object

serializedName

serializedName: string = "UpgradePhase"

type

type: object

name

name: "String" = "String"

Const NodesHealthEvaluation

NodesHealthEvaluation: object

Represents health evaluation for nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health and the aggregated health state is either Error or Warning.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional description

description: undefined | string

Description of the health evaluation, which represents a summary of the evaluation process.

kind

kind: "Nodes"

Polymorphic Discriminator

Optional maxPercentUnhealthyNodes

maxPercentUnhealthyNodes: undefined | number

Maximum allowed percentage of unhealthy nodes from the ClusterHealthPolicy.

Optional totalCount

totalCount: undefined | number

Total number of nodes found in the health store.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health.

serializedName

serializedName: string = "Nodes"

type

type: object

className

className: string = "NodesHealthEvaluation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = HealthEvaluation.type.polymorphicDiscriminator

uberParent

uberParent: string = "HealthEvaluation"

modelProperties

modelProperties: object

maxPercentUnhealthyNodes

maxPercentUnhealthyNodes: object

serializedName

serializedName: string = "MaxPercentUnhealthyNodes"

type

type: object

name

name: "Number" = "Number"

totalCount

totalCount: object

serializedName

serializedName: string = "TotalCount"

type

type: object

name

name: "Number" = "Number"

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

Const OperationStatus

OperationStatus: object

Contains the OperationId, OperationState, and OperationType for user-induced operations.

Optional operationId

operationId: undefined | string

A GUID that identifies a call to this API. This is also passed into the corresponding GetProgress API.

Optional state

The state of the operation. Possible values include: 'Invalid', 'Running', 'RollingBack', 'Completed', 'Faulted', 'Cancelled', 'ForceCancelled'

serializedName

serializedName: string = "OperationStatus"

Optional type

type: object

The type of the operation. Possible values include: 'Invalid', 'PartitionDataLoss', 'PartitionQuorumLoss', 'PartitionRestart', 'NodeTransition'

className

className: string = "OperationStatus"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

operationId

operationId: object

serializedName

serializedName: string = "OperationId"

type

type: object

name

name: "Uuid" = "Uuid"

state

state: object

serializedName

serializedName: string = "State"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "Type"

type

type: object

name

name: "String" = "String"

Const PackageSharingPolicyInfo

PackageSharingPolicyInfo: object

Represents a policy for the package sharing.

Optional packageSharingScope

packageSharingScope: PackageSharingPolicyScope

Represents the scope for PackageSharingPolicy. This is specified during DeployServicePackageToNode operation. Possible values include: 'None', 'All', 'Code', 'Config', 'Data'

Optional sharedPackageName

sharedPackageName: undefined | string

The name of code, configuration or data package that should be shared.

serializedName

serializedName: string = "PackageSharingPolicyInfo"

type

type: object

className

className: string = "PackageSharingPolicyInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

packageSharingScope

packageSharingScope: object

serializedName

serializedName: string = "PackageSharingScope"

type

type: object

name

name: "String" = "String"

sharedPackageName

sharedPackageName: object

serializedName

serializedName: string = "SharedPackageName"

type

type: object

name

name: "String" = "String"

Const PagedApplicationInfoList

PagedApplicationInfoList: object

The list of applications in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional items

List of application information.

serializedName

serializedName: string = "PagedApplicationInfoList"

type

type: object

className

className: string = "PagedApplicationInfoList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationInfo"

name

name: "Composite" = "Composite"

Const PagedApplicationResourceDescriptionList

PagedApplicationResourceDescriptionList: object

The list of application resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional items

One page of the list.

serializedName

serializedName: string = "PagedApplicationResourceDescriptionList"

type

type: object

className

className: string = "PagedApplicationResourceDescriptionList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationResourceDescription"

name

name: "Composite" = "Composite"

Const PagedApplicationTypeInfoList

PagedApplicationTypeInfoList: object

The list of application types that are provisioned or being provisioned in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional items

List of application type information.

serializedName

serializedName: string = "PagedApplicationTypeInfoList"

type

type: object

className

className: string = "PagedApplicationTypeInfoList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationTypeInfo"

name

name: "Composite" = "Composite"

Const PagedBackupConfigurationInfoList

PagedBackupConfigurationInfoList: object

The list of backup configuration information. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional items

List of backup configuration information.

serializedName

serializedName: string = "PagedBackupConfigurationInfoList"

type

type: object

className

className: string = "PagedBackupConfigurationInfoList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BackupConfigurationInfo"

name

name: "Composite" = "Composite"

Const PagedBackupEntityList

PagedBackupEntityList: object

The list of backup entities that are being periodically backed. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional items

List of backup entity information.

serializedName

serializedName: string = "PagedBackupEntityList"

type

type: object

className

className: string = "PagedBackupEntityList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BackupEntity"

name

name: "Composite" = "Composite"

Const PagedBackupInfoList

PagedBackupInfoList: object

The list of backups. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional items

items: BackupInfo[]

List of backup information.

serializedName

serializedName: string = "PagedBackupInfoList"

type

type: object

className

className: string = "PagedBackupInfoList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BackupInfo"

name

name: "Composite" = "Composite"

Const PagedBackupPolicyDescriptionList

PagedBackupPolicyDescriptionList: object

The list of backup policies configured in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional items

The list of backup policies information.

serializedName

serializedName: string = "PagedBackupPolicyDescriptionList"

type

type: object

className

className: string = "PagedBackupPolicyDescriptionList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BackupPolicyDescription"

name

name: "Composite" = "Composite"

Const PagedComposeDeploymentStatusInfoList

PagedComposeDeploymentStatusInfoList: object

The list of compose deployments in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional items

List of compose deployment status information.

serializedName

serializedName: string = "PagedComposeDeploymentStatusInfoList"

type

type: object

className

className: string = "PagedComposeDeploymentStatusInfoList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ComposeDeploymentStatusInfo"

name

name: "Composite" = "Composite"

Const PagedDeployedApplicationInfoList

PagedDeployedApplicationInfoList: object

The list of deployed applications in activating, downloading, or active states on a node. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional items

List of deployed application information.

serializedName

serializedName: string = "PagedDeployedApplicationInfoList"

type

type: object

className

className: string = "PagedDeployedApplicationInfoList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DeployedApplicationInfo"

name

name: "Composite" = "Composite"

Const PagedGatewayResourceDescriptionList

PagedGatewayResourceDescriptionList: object

The list of gateway resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional items

One page of the list.

serializedName

serializedName: string = "PagedGatewayResourceDescriptionList"

type

type: object

className

className: string = "PagedGatewayResourceDescriptionList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "GatewayResourceDescription"

name

name: "Composite" = "Composite"

Const PagedNetworkResourceDescriptionList

PagedNetworkResourceDescriptionList: object

The list of network resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional items

One page of the list.

serializedName

serializedName: string = "PagedNetworkResourceDescriptionList"

type

type: object

className

className: string = "PagedNetworkResourceDescriptionList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkResourceDescription"

name

name: "Composite" = "Composite"

Const PagedNodeInfoList

PagedNodeInfoList: object

The list of nodes in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional items

items: NodeInfo[]

List of node information.

serializedName

serializedName: string = "PagedNodeInfoList"

type

type: object

className

className: string = "PagedNodeInfoList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NodeInfo"

name

name: "Composite" = "Composite"

Const PagedPropertyInfoList

PagedPropertyInfoList: object

The paged list of Service Fabric properties under a given name. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional isConsistent

isConsistent: undefined | false | true

Indicates whether any property under the given name has been modified during the enumeration. If there was a modification, this property value is false.

Optional properties

properties: PropertyInfo[]

List of property information.

serializedName

serializedName: string = "PagedPropertyInfoList"

type

type: object

className

className: string = "PagedPropertyInfoList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

isConsistent

isConsistent: object

serializedName

serializedName: string = "IsConsistent"

type

type: object

name

name: "Boolean" = "Boolean"

properties

properties: object

serializedName

serializedName: string = "Properties"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PropertyInfo"

name

name: "Composite" = "Composite"

Const PagedReplicaInfoList

PagedReplicaInfoList: object

The list of replicas in the cluster for a given partition. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional items

List of replica information.

serializedName

serializedName: string = "PagedReplicaInfoList"

type

type: object

className

className: string = "PagedReplicaInfoList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ReplicaInfo"

name

name: "Composite" = "Composite"

Const PagedSecretResourceDescriptionList

PagedSecretResourceDescriptionList: object

The list of secret resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional items

One page of the list.

serializedName

serializedName: string = "PagedSecretResourceDescriptionList"

type

type: object

className

className: string = "PagedSecretResourceDescriptionList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SecretResourceDescription"

name

name: "Composite" = "Composite"

Const PagedSecretValueResourceDescriptionList

PagedSecretValueResourceDescriptionList: object

The list of values of a secret resource, paged if the number of results exceeds the limits of a single message. The next set of results can be obtained by executing the same query with the continuation token provided in the previous page.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional items

One page of the list.

serializedName

serializedName: string = "PagedSecretValueResourceDescriptionList"

type

type: object

className

className: string = "PagedSecretValueResourceDescriptionList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SecretValueResourceDescription"

name

name: "Composite" = "Composite"

Const PagedServiceInfoList

PagedServiceInfoList: object

The list of services in the cluster for an application. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional items

List of service information.

serializedName

serializedName: string = "PagedServiceInfoList"

type

type: object

className

className: string = "PagedServiceInfoList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceInfo"

name

name: "Composite" = "Composite"

Const PagedServicePartitionInfoList

PagedServicePartitionInfoList: object

The list of partition in the cluster for a service. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional items

List of service partition information.

serializedName

serializedName: string = "PagedServicePartitionInfoList"

type

type: object

className

className: string = "PagedServicePartitionInfoList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServicePartitionInfo"

name

name: "Composite" = "Composite"

Const PagedServiceReplicaDescriptionList

PagedServiceReplicaDescriptionList: object

The list of service resource replicas in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional items

List of service resource replica description.

serializedName

serializedName: string = "PagedServiceReplicaDescriptionList"

type

type: object

className

className: string = "PagedServiceReplicaDescriptionList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceReplicaDescription"

name

name: "Composite" = "Composite"

Const PagedServiceResourceDescriptionList

PagedServiceResourceDescriptionList: object

The list of service resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional items

One page of the list.

serializedName

serializedName: string = "PagedServiceResourceDescriptionList"

type

type: object

className

className: string = "PagedServiceResourceDescriptionList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceResourceDescription"

name

name: "Composite" = "Composite"

Const PagedSubNameInfoList

PagedSubNameInfoList: object

A paged list of Service Fabric names. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional isConsistent

isConsistent: undefined | false | true

Indicates whether any name under the given name has been modified during the enumeration. If there was a modification, this property value is false.

Optional subNames

subNames: string[]

List of the child names.

serializedName

serializedName: string = "PagedSubNameInfoList"

type

type: object

className

className: string = "PagedSubNameInfoList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

isConsistent

isConsistent: object

serializedName

serializedName: string = "IsConsistent"

type

type: object

name

name: "Boolean" = "Boolean"

subNames

subNames: object

serializedName

serializedName: string = "SubNames"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const PagedVolumeResourceDescriptionList

PagedVolumeResourceDescriptionList: object

The list of volume resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.

Optional items

One page of the list.

serializedName

serializedName: string = "PagedVolumeResourceDescriptionList"

type

type: object

className

className: string = "PagedVolumeResourceDescriptionList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VolumeResourceDescription"

name

name: "Composite" = "Composite"

Const PartitionAnalysisEvent

PartitionAnalysisEvent: object

Represents the base for all Partition Analysis Events.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "PartitionAnalysisEvent"

Polymorphic Discriminator

metadata

Metadata about an Analysis Event.

partitionId

partitionId: string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "PartitionAnalysisEvent"

type

type: object

className

className: string = "PartitionAnalysisEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

metadata

metadata: object

required

required: true = true

serializedName

serializedName: string = "Metadata"

type

type: object

className

className: string = "AnalysisEventMetadata"

name

name: "Composite" = "Composite"

Const PartitionBackupConfigurationInfo

PartitionBackupConfigurationInfo: object

Backup configuration information, for a specific partition, specifying what backup policy is being applied and suspend description, if any.

kind

kind: "Partition"

Polymorphic Discriminator

Optional partitionId

partitionId: undefined | string

The partition ID identifying the partition.

Optional policyInheritedFrom

policyInheritedFrom: BackupPolicyScope

Specifies the scope at which the backup policy is applied. Possible values include: 'Invalid', 'Partition', 'Service', 'Application'

Optional policyName

policyName: undefined | string

The name of the backup policy which is applicable to this Service Fabric application or service or partition.

Optional serviceName

serviceName: undefined | string

The full name of the service with 'fabric:' URI scheme.

Optional suspensionInfo

suspensionInfo: BackupSuspensionInfo

Describes the backup suspension details.

serializedName

serializedName: string = "Partition"

type

type: object

className

className: string = "PartitionBackupConfigurationInfo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = BackupConfigurationInfo.type.polymorphicDiscriminator

uberParent

uberParent: string = "BackupConfigurationInfo"

modelProperties

modelProperties: object

partitionId

partitionId: object

serializedName

serializedName: string = "PartitionId"

type

type: object

name

name: "Uuid" = "Uuid"

serviceName

serviceName: object

serializedName

serializedName: string = "ServiceName"

type

type: object

name

name: "String" = "String"

Const PartitionBackupEntity

PartitionBackupEntity: object

Identifies the Service Fabric stateful partition which is being backed up.

entityKind

entityKind: "Partition"

Polymorphic Discriminator

Optional partitionId

partitionId: undefined | string

The partition ID identifying the partition.

Optional serviceName

serviceName: undefined | string

The full name of the service with 'fabric:' URI scheme.

serializedName

serializedName: string = "Partition"

type

type: object

className

className: string = "PartitionBackupEntity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = BackupEntity.type.polymorphicDiscriminator

uberParent

uberParent: string = "BackupEntity"

modelProperties

modelProperties: object

partitionId

partitionId: object

serializedName

serializedName: string = "PartitionId"

type

type: object

name

name: "Uuid" = "Uuid"

serviceName

serviceName: object

serializedName

serializedName: string = "ServiceName"

type

type: object

name

name: "String" = "String"

Const PartitionDataLossProgress

PartitionDataLossProgress: object

Information about a partition data loss user-induced operation.

Optional invokeDataLossResult

invokeDataLossResult: InvokeDataLossResult

Represents information about an operation in a terminal state (Completed or Faulted).

Optional state

The state of the operation. Possible values include: 'Invalid', 'Running', 'RollingBack', 'Completed', 'Faulted', 'Cancelled', 'ForceCancelled'

serializedName

serializedName: string = "PartitionDataLossProgress"

type

type: object

className

className: string = "PartitionDataLossProgress"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

invokeDataLossResult

invokeDataLossResult: object

serializedName

serializedName: string = "InvokeDataLossResult"

type

type: object

className

className: string = "InvokeDataLossResult"

name

name: "Composite" = "Composite"

state

state: object

serializedName

serializedName: string = "State"

type

type: object

name

name: "String" = "String"

Const PartitionEvent

PartitionEvent: object

Represents the base for all Partition Events.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "PartitionEvent"

Polymorphic Discriminator

partitionId

partitionId: string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "PartitionEvent"

type

type: object

className

className: string = "PartitionEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

partitionId

partitionId: object

required

required: true = true

serializedName

serializedName: string = "PartitionId"

type

type: object

name

name: "Uuid" = "Uuid"

Const PartitionHealth

PartitionHealth: object

Information about the health of a Service Fabric partition.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional healthEvents

healthEvents: HealthEvent[]

The list of health events reported on the entity.

Optional healthStatistics

healthStatistics: HealthStatistics

Shows the health statistics for all children types of the queried entity.

Optional partitionId

partitionId: undefined | string

ID of the partition whose health information is described by this object.

Optional replicaHealthStates

replicaHealthStates: ReplicaHealthStateUnion[]

The list of replica health states associated with the partition.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.

serializedName

serializedName: string = "PartitionHealth"

type

type: object

className

className: string = "PartitionHealth"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

partitionId

partitionId: object

serializedName

serializedName: string = "PartitionId"

type

type: object

name

name: "Uuid" = "Uuid"

replicaHealthStates

replicaHealthStates: object

serializedName

serializedName: string = "ReplicaHealthStates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ReplicaHealthState"

name

name: "Composite" = "Composite"

Const PartitionHealthEvaluation

PartitionHealthEvaluation: object

Represents health evaluation for a partition, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional description

description: undefined | string

Description of the health evaluation, which represents a summary of the evaluation process.

kind

kind: "Partition"

Polymorphic Discriminator

Optional partitionId

partitionId: undefined | string

Id of the partition whose health evaluation is described by this object.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

List of unhealthy evaluations that led to the current aggregated health state of the partition. The types of the unhealthy evaluations can be ReplicasHealthEvaluation or EventHealthEvaluation.

serializedName

serializedName: string = "Partition"

type

type: object

className

className: string = "PartitionHealthEvaluation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = HealthEvaluation.type.polymorphicDiscriminator

uberParent

uberParent: string = "HealthEvaluation"

modelProperties

modelProperties: object

partitionId

partitionId: object

serializedName

serializedName: string = "PartitionId"

type

type: object

name

name: "Uuid" = "Uuid"

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

Const PartitionHealthReportExpiredEvent

PartitionHealthReportExpiredEvent: object

Partition Health Report Expired event.

Optional category

category: undefined | string

The category of event.

description

description: string

Description of report.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

healthState

healthState: string

Describes the property health state.

kind

kind: "PartitionHealthReportExpired"

Polymorphic Discriminator

partitionId

partitionId: string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

property

property: string

Describes the property.

removeWhenExpired

removeWhenExpired: boolean

Indicates the removal when it expires.

sequenceNumber

sequenceNumber: number

Sequence number of report.

sourceId

sourceId: string

Id of report source.

sourceUtcTimestamp

sourceUtcTimestamp: Date

Source time.

timeStamp

timeStamp: Date

The time event was logged.

timeToLiveMs

timeToLiveMs: number

Time to live in milli-seconds.

serializedName

serializedName: string = "PartitionHealthReportExpired"

type

type: object

className

className: string = "PartitionHealthReportExpiredEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

description

description: object

required

required: true = true

serializedName

serializedName: string = "Description"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

required

required: true = true

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

property

property: object

required

required: true = true

serializedName

serializedName: string = "Property"

type

type: object

name

name: "String" = "String"

removeWhenExpired

removeWhenExpired: object

required

required: true = true

serializedName

serializedName: string = "RemoveWhenExpired"

type

type: object

name

name: "Boolean" = "Boolean"

sequenceNumber

sequenceNumber: object

required

required: true = true

serializedName

serializedName: string = "SequenceNumber"

type

type: object

name

name: "Number" = "Number"

sourceId

sourceId: object

required

required: true = true

serializedName

serializedName: string = "SourceId"

type

type: object

name

name: "String" = "String"

sourceUtcTimestamp

sourceUtcTimestamp: object

required

required: true = true

serializedName

serializedName: string = "SourceUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

timeToLiveMs

timeToLiveMs: object

required

required: true = true

serializedName

serializedName: string = "TimeToLiveMs"

type

type: object

name

name: "Number" = "Number"

Const PartitionHealthState

PartitionHealthState: object

Represents the health state of a partition, which contains the partition identifier and its aggregated health state.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional partitionId

partitionId: undefined | string

Id of the partition whose health state is described by this object.

serializedName

serializedName: string = "PartitionHealthState"

type

type: object

className

className: string = "PartitionHealthState"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

partitionId

partitionId: object

serializedName

serializedName: string = "PartitionId"

type

type: object

name

name: "Uuid" = "Uuid"

Const PartitionHealthStateChunk

PartitionHealthStateChunk: object

Represents the health state chunk of a partition, which contains the partition ID, its aggregated health state and any replicas that respect the filters in the cluster health chunk query description.

Optional healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional partitionId

partitionId: undefined | string

The Id of the partition.

Optional replicaHealthStateChunks

replicaHealthStateChunks: ReplicaHealthStateChunkList

The list of replica health state chunks belonging to the partition that respect the filters in the cluster health chunk query description.

serializedName

serializedName: string = "PartitionHealthStateChunk"

type

type: object

className

className: string = "PartitionHealthStateChunk"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

partitionId

partitionId: object

serializedName

serializedName: string = "PartitionId"

type

type: object

name

name: "Uuid" = "Uuid"

replicaHealthStateChunks

replicaHealthStateChunks: object

serializedName

serializedName: string = "ReplicaHealthStateChunks"

type

type: object

className

className: string = "ReplicaHealthStateChunkList"

name

name: "Composite" = "Composite"

Const PartitionHealthStateChunkList

PartitionHealthStateChunkList: object

The list of partition health state chunks that respect the input filters in the chunk query description. Returned by get cluster health state chunks query as part of the parent application hierarchy.

Optional items

The list of partition health state chunks that respect the input filters in the chunk query.

serializedName

serializedName: string = "PartitionHealthStateChunkList"

type

type: object

className

className: string = "PartitionHealthStateChunkList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PartitionHealthStateChunk"

name

name: "Composite" = "Composite"

Const PartitionHealthStateFilter

PartitionHealthStateFilter: object

Defines matching criteria to determine whether a partition should be included as a child of a service in the cluster health chunk. The partitions are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent service and application must be included in the cluster health chunk. One filter can match zero, one or multiple partitions, depending on its properties.

Optional healthStateFilter

healthStateFilter: undefined | number

The filter for the health state of the partitions. It allows selecting partitions if they match the desired health states. The possible values are integer value of one of the following health states. Only partitions that match the filter are returned. All partitions are used to evaluate the cluster aggregated health state. If not specified, default value is None, unless the partition ID is specified. If the filter has default value and partition ID is specified, the matching partition is returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6, it matches partitions with HealthState value of OK (2) and Warning (4).

  • Default - Default value. Matches any HealthState. The value is zero.
  • None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.
  • Ok - Filter that matches input with HealthState value Ok. The value is 2.
  • Warning - Filter that matches input with HealthState value Warning. The value is 4.
  • Error - Filter that matches input with HealthState value Error. The value is 8.
  • All - Filter that matches input with any HealthState value. The value is 65535. Default value: 0.

Optional partitionIdFilter

partitionIdFilter: undefined | string

ID of the partition that matches the filter. The filter is applied only to the specified partition, if it exists. If the partition doesn't exist, no partition is returned in the cluster health chunk based on this filter. If the partition exists, it is included in the cluster health chunk if it respects the other filter properties. If not specified, all partitions that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.

Optional replicaFilters

replicaFilters: ReplicaHealthStateFilter[]

Defines a list of filters that specify which replicas to be included in the returned cluster health chunk as children of the parent partition. The replicas are returned only if the parent partition matches a filter. If the list is empty, no replicas are returned. All the replicas are used to evaluate the parent partition aggregated health state, regardless of the input filters. The partition filter may specify multiple replica filters. For example, it can specify a filter to return all replicas with health state Error and another filter to always include a replica identified by its replica id.

serializedName

serializedName: string = "PartitionHealthStateFilter"

type

type: object

className

className: string = "PartitionHealthStateFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

healthStateFilter

healthStateFilter: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "HealthStateFilter"

type

type: object

name

name: "Number" = "Number"

partitionIdFilter

partitionIdFilter: object

serializedName

serializedName: string = "PartitionIdFilter"

type

type: object

name

name: "Uuid" = "Uuid"

replicaFilters

replicaFilters: object

serializedName

serializedName: string = "ReplicaFilters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ReplicaHealthStateFilter"

name

name: "Composite" = "Composite"

Const PartitionInformation

PartitionInformation: object

Information about the partition identity, partitioning scheme and keys supported by it.

Optional id

id: undefined | string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

servicePartitionKind

servicePartitionKind: "PartitionInformation"

Polymorphic Discriminator

serializedName

serializedName: string = "PartitionInformation"

type

type: object

className

className: string = "PartitionInformation"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "PartitionInformation"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "Id"

type

type: object

name

name: "Uuid" = "Uuid"

servicePartitionKind

servicePartitionKind: object

required

required: true = true

serializedName

serializedName: string = "ServicePartitionKind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "servicePartitionKind"

serializedName

serializedName: string = "ServicePartitionKind"

Const PartitionInstanceCountScaleMechanism

PartitionInstanceCountScaleMechanism: object

Represents a scaling mechanism for adding or removing instances of stateless service partition.

kind

kind: "PartitionInstanceCount"

Polymorphic Discriminator

maxInstanceCount

maxInstanceCount: number

Maximum number of instances of the partition.

minInstanceCount

minInstanceCount: number

Minimum number of instances of the partition.

scaleIncrement

scaleIncrement: number

The number of instances to add or remove during a scaling operation.

serializedName

serializedName: string = "PartitionInstanceCount"

type

type: object

className

className: string = "PartitionInstanceCountScaleMechanism"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ScalingMechanismDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "ScalingMechanismDescription"

modelProperties

modelProperties: object

maxInstanceCount

maxInstanceCount: object

required

required: true = true

serializedName

serializedName: string = "MaxInstanceCount"

type

type: object

name

name: "Number" = "Number"

minInstanceCount

minInstanceCount: object

required

required: true = true

serializedName

serializedName: string = "MinInstanceCount"

type

type: object

name

name: "Number" = "Number"

scaleIncrement

scaleIncrement: object

required

required: true = true

serializedName

serializedName: string = "ScaleIncrement"

type

type: object

name

name: "Number" = "Number"

Const PartitionLoadInformation

PartitionLoadInformation: object

Represents load information for a partition, which contains the primary and secondary reported load metrics. In case there is no load reported, PartitionLoadInformation will contain the default load for the service of the partition. For default loads, LoadMetricReport's LastReportedUtc is set to 0.

Optional partitionId

partitionId: undefined | string

Id of the partition.

Optional primaryLoadMetricReports

primaryLoadMetricReports: LoadMetricReport[]

Array of load reports from the primary replica for this partition.

Optional secondaryLoadMetricReports

secondaryLoadMetricReports: LoadMetricReport[]

Array of aggregated load reports from all secondary replicas for this partition. Array only contains the latest reported load for each metric.

serializedName

serializedName: string = "PartitionLoadInformation"

type

type: object

className

className: string = "PartitionLoadInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

partitionId

partitionId: object

serializedName

serializedName: string = "PartitionId"

type

type: object

name

name: "Uuid" = "Uuid"

primaryLoadMetricReports

primaryLoadMetricReports: object

serializedName

serializedName: string = "PrimaryLoadMetricReports"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LoadMetricReport"

name

name: "Composite" = "Composite"

secondaryLoadMetricReports

secondaryLoadMetricReports: object

serializedName

serializedName: string = "SecondaryLoadMetricReports"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LoadMetricReport"

name

name: "Composite" = "Composite"

Const PartitionNewHealthReportEvent

PartitionNewHealthReportEvent: object

Partition Health Report Created event.

Optional category

category: undefined | string

The category of event.

description

description: string

Description of report.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

healthState

healthState: string

Describes the property health state.

kind

kind: "PartitionNewHealthReport"

Polymorphic Discriminator

partitionId

partitionId: string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

property

property: string

Describes the property.

removeWhenExpired

removeWhenExpired: boolean

Indicates the removal when it expires.

sequenceNumber

sequenceNumber: number

Sequence number of report.

sourceId

sourceId: string

Id of report source.

sourceUtcTimestamp

sourceUtcTimestamp: Date

Source time.

timeStamp

timeStamp: Date

The time event was logged.

timeToLiveMs

timeToLiveMs: number

Time to live in milli-seconds.

serializedName

serializedName: string = "PartitionNewHealthReport"

type

type: object

className

className: string = "PartitionNewHealthReportEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

description

description: object

required

required: true = true

serializedName

serializedName: string = "Description"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

required

required: true = true

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

property

property: object

required

required: true = true

serializedName

serializedName: string = "Property"

type

type: object

name

name: "String" = "String"

removeWhenExpired

removeWhenExpired: object

required

required: true = true

serializedName

serializedName: string = "RemoveWhenExpired"

type

type: object

name

name: "Boolean" = "Boolean"

sequenceNumber

sequenceNumber: object

required

required: true = true

serializedName

serializedName: string = "SequenceNumber"

type

type: object

name

name: "Number" = "Number"

sourceId

sourceId: object

required

required: true = true

serializedName

serializedName: string = "SourceId"

type

type: object

name

name: "String" = "String"

sourceUtcTimestamp

sourceUtcTimestamp: object

required

required: true = true

serializedName

serializedName: string = "SourceUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

timeToLiveMs

timeToLiveMs: object

required

required: true = true

serializedName

serializedName: string = "TimeToLiveMs"

type

type: object

name

name: "Number" = "Number"

Const PartitionPrimaryMoveAnalysisEvent

PartitionPrimaryMoveAnalysisEvent: object

Partition Primary Move Analysis event.

Optional category

category: undefined | string

The category of event.

currentNode

currentNode: string

The name of a Service Fabric node.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "PartitionPrimaryMoveAnalysis"

Polymorphic Discriminator

metadata

Metadata about an Analysis Event.

moveReason

moveReason: string

Move reason.

partitionId

partitionId: string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

previousNode

previousNode: string

The name of a Service Fabric node.

relevantTraces

relevantTraces: string

Relevant traces.

timeStamp

timeStamp: Date

The time event was logged.

whenMoveCompleted

whenMoveCompleted: Date

Time when the move was completed.

serializedName

serializedName: string = "PartitionPrimaryMoveAnalysis"

type

type: object

className

className: string = "PartitionPrimaryMoveAnalysisEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

currentNode

currentNode: object

required

required: true = true

serializedName

serializedName: string = "CurrentNode"

type

type: object

name

name: "String" = "String"

moveReason

moveReason: object

required

required: true = true

serializedName

serializedName: string = "MoveReason"

type

type: object

name

name: "String" = "String"

previousNode

previousNode: object

required

required: true = true

serializedName

serializedName: string = "PreviousNode"

type

type: object

name

name: "String" = "String"

relevantTraces

relevantTraces: object

required

required: true = true

serializedName

serializedName: string = "RelevantTraces"

type

type: object

name

name: "String" = "String"

whenMoveCompleted

whenMoveCompleted: object

required

required: true = true

serializedName

serializedName: string = "WhenMoveCompleted"

type

type: object

name

name: "DateTime" = "DateTime"

Const PartitionQuorumLossProgress

PartitionQuorumLossProgress: object

Information about a partition quorum loss user-induced operation.

Optional invokeQuorumLossResult

invokeQuorumLossResult: InvokeQuorumLossResult

Represents information about an operation in a terminal state (Completed or Faulted).

Optional state

The state of the operation. Possible values include: 'Invalid', 'Running', 'RollingBack', 'Completed', 'Faulted', 'Cancelled', 'ForceCancelled'

serializedName

serializedName: string = "PartitionQuorumLossProgress"

type

type: object

className

className: string = "PartitionQuorumLossProgress"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

invokeQuorumLossResult

invokeQuorumLossResult: object

serializedName

serializedName: string = "InvokeQuorumLossResult"

type

type: object

className

className: string = "InvokeQuorumLossResult"

name

name: "Composite" = "Composite"

state

state: object

serializedName

serializedName: string = "State"

type

type: object

name

name: "String" = "String"

Const PartitionReconfiguredEvent

PartitionReconfiguredEvent: object

Partition Reconfiguration event.

Optional category

category: undefined | string

The category of event.

ccEpochConfigVersion

ccEpochConfigVersion: number

CcEpochConfig version.

ccEpochDataLossVersion

ccEpochDataLossVersion: number

CcEpochDataLoss version.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "PartitionReconfigured"

Polymorphic Discriminator

nodeInstanceId

nodeInstanceId: string

Id of Node instance.

nodeName

nodeName: string

The name of a Service Fabric node.

partitionId

partitionId: string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

phase0DurationMs

phase0DurationMs: number

Duration of Phase0 in milli-seconds.

phase1DurationMs

phase1DurationMs: number

Duration of Phase1 in milli-seconds.

phase2DurationMs

phase2DurationMs: number

Duration of Phase2 in milli-seconds.

phase3DurationMs

phase3DurationMs: number

Duration of Phase3 in milli-seconds.

phase4DurationMs

phase4DurationMs: number

Duration of Phase4 in milli-seconds.

reconfigType

reconfigType: string

Type of reconfiguration.

result

result: string

Describes reconfiguration result.

serviceType

serviceType: string

Type of Service.

timeStamp

timeStamp: Date

The time event was logged.

totalDurationMs

totalDurationMs: number

Total duration in milli-seconds.

serializedName

serializedName: string = "PartitionReconfigured"

type

type: object

className

className: string = "PartitionReconfiguredEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

ccEpochConfigVersion

ccEpochConfigVersion: object

required

required: true = true

serializedName

serializedName: string = "CcEpochConfigVersion"

type

type: object

name

name: "Number" = "Number"

ccEpochDataLossVersion

ccEpochDataLossVersion: object

required

required: true = true

serializedName

serializedName: string = "CcEpochDataLossVersion"

type

type: object

name

name: "Number" = "Number"

nodeInstanceId

nodeInstanceId: object

required

required: true = true

serializedName

serializedName: string = "NodeInstanceId"

type

type: object

name

name: "String" = "String"

nodeName

nodeName: object

required

required: true = true

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

phase0DurationMs

phase0DurationMs: object

required

required: true = true

serializedName

serializedName: string = "Phase0DurationMs"

type

type: object

name

name: "Number" = "Number"

phase1DurationMs

phase1DurationMs: object

required

required: true = true

serializedName

serializedName: string = "Phase1DurationMs"

type

type: object

name

name: "Number" = "Number"

phase2DurationMs

phase2DurationMs: object

required

required: true = true

serializedName

serializedName: string = "Phase2DurationMs"

type

type: object

name

name: "Number" = "Number"

phase3DurationMs

phase3DurationMs: object

required

required: true = true

serializedName

serializedName: string = "Phase3DurationMs"

type

type: object

name

name: "Number" = "Number"

phase4DurationMs

phase4DurationMs: object

required

required: true = true

serializedName

serializedName: string = "Phase4DurationMs"

type

type: object

name

name: "Number" = "Number"

reconfigType

reconfigType: object

required

required: true = true

serializedName

serializedName: string = "ReconfigType"

type

type: object

name

name: "String" = "String"

result

result: object

required

required: true = true

serializedName

serializedName: string = "Result"

type

type: object

name

name: "String" = "String"

serviceType

serviceType: object

required

required: true = true

serializedName

serializedName: string = "ServiceType"

type

type: object

name

name: "String" = "String"

totalDurationMs

totalDurationMs: object

required

required: true = true

serializedName

serializedName: string = "TotalDurationMs"

type

type: object

name

name: "Number" = "Number"

Const PartitionRestartProgress

PartitionRestartProgress: object

Information about a partition restart user-induced operation.

Optional restartPartitionResult

restartPartitionResult: RestartPartitionResult

Represents information about an operation in a terminal state (Completed or Faulted).

Optional state

The state of the operation. Possible values include: 'Invalid', 'Running', 'RollingBack', 'Completed', 'Faulted', 'Cancelled', 'ForceCancelled'

serializedName

serializedName: string = "PartitionRestartProgress"

type

type: object

className

className: string = "PartitionRestartProgress"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

restartPartitionResult

restartPartitionResult: object

serializedName

serializedName: string = "RestartPartitionResult"

type

type: object

className

className: string = "RestartPartitionResult"

name

name: "Composite" = "Composite"

state

state: object

serializedName

serializedName: string = "State"

type

type: object

name

name: "String" = "String"

Const PartitionSafetyCheck

PartitionSafetyCheck: object

Represents a safety check for the service partition being performed by service fabric before continuing with operations.

kind

kind: "PartitionSafetyCheck"

Polymorphic Discriminator

Optional partitionId

partitionId: undefined | string

Id of the partition which is undergoing the safety check.

serializedName

serializedName: string = "PartitionSafetyCheck"

type

type: object

className

className: string = "PartitionSafetyCheck"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = SafetyCheck.type.polymorphicDiscriminator

uberParent

uberParent: string = "SafetyCheck"

modelProperties

modelProperties: object

partitionId

partitionId: object

serializedName

serializedName: string = "PartitionId"

type

type: object

name

name: "Uuid" = "Uuid"

Const PartitionSchemeDescription

PartitionSchemeDescription: object

Describes how the service is partitioned.

partitionScheme

partitionScheme: "PartitionSchemeDescription"

Polymorphic Discriminator

serializedName

serializedName: string = "PartitionSchemeDescription"

type

type: object

className

className: string = "PartitionSchemeDescription"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "PartitionSchemeDescription"

modelProperties

modelProperties: object

partitionScheme

partitionScheme: object

required

required: true = true

serializedName

serializedName: string = "PartitionScheme"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "partitionScheme"

serializedName

serializedName: string = "PartitionScheme"

Const PartitionsHealthEvaluation

PartitionsHealthEvaluation: object

Represents health evaluation for the partitions of a service, containing health evaluations for each unhealthy partition that impacts current aggregated health state. Can be returned when evaluating service health and the aggregated health state is either Error or Warning.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional description

description: undefined | string

Description of the health evaluation, which represents a summary of the evaluation process.

kind

kind: "Partitions"

Polymorphic Discriminator

Optional maxPercentUnhealthyPartitionsPerService

maxPercentUnhealthyPartitionsPerService: undefined | number

Maximum allowed percentage of unhealthy partitions per service from the ServiceTypeHealthPolicy.

Optional totalCount

totalCount: undefined | number

Total number of partitions of the service from the health store.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy PartitionHealthEvaluation that impacted the aggregated health.

serializedName

serializedName: string = "Partitions"

type

type: object

className

className: string = "PartitionsHealthEvaluation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = HealthEvaluation.type.polymorphicDiscriminator

uberParent

uberParent: string = "HealthEvaluation"

modelProperties

modelProperties: object

maxPercentUnhealthyPartitionsPerService

maxPercentUnhealthyPartitionsPerService: object

serializedName

serializedName: string = "MaxPercentUnhealthyPartitionsPerService"

type

type: object

name

name: "Number" = "Number"

totalCount

totalCount: object

serializedName

serializedName: string = "TotalCount"

type

type: object

name

name: "Number" = "Number"

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

Const PrimaryReplicatorStatus

PrimaryReplicatorStatus: object

Provides statistics about the Service Fabric Replicator, when it is functioning in a Primary role.

kind

kind: "Primary"

Polymorphic Discriminator

Optional remoteReplicators

remoteReplicators: RemoteReplicatorStatus[]

The status of all the active and idle secondary replicators that the primary is aware of.

Optional replicationQueueStatus

replicationQueueStatus: ReplicatorQueueStatus

Details about the replication queue on the primary replicator.

serializedName

serializedName: string = "Primary"

type

type: object

className

className: string = "PrimaryReplicatorStatus"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ReplicatorStatus.type.polymorphicDiscriminator

uberParent

uberParent: string = "ReplicatorStatus"

modelProperties

modelProperties: object

remoteReplicators

remoteReplicators: object

serializedName

serializedName: string = "RemoteReplicators"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RemoteReplicatorStatus"

name

name: "Composite" = "Composite"

replicationQueueStatus

replicationQueueStatus: object

serializedName

serializedName: string = "ReplicationQueueStatus"

type

type: object

className

className: string = "ReplicatorQueueStatus"

name

name: "Composite" = "Composite"

Const PropertyBatchDescriptionList

PropertyBatchDescriptionList: object

Describes a list of property batch operations to be executed. Either all or none of the operations will be committed.

Optional operations

A list of the property batch operations to be executed.

serializedName

serializedName: string = "PropertyBatchDescriptionList"

type

type: object

className

className: string = "PropertyBatchDescriptionList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

operations

operations: object

serializedName

serializedName: string = "Operations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PropertyBatchOperation"

name

name: "Composite" = "Composite"

Const PropertyBatchInfo

PropertyBatchInfo: object

Information about the results of a property batch.

kind

kind: "PropertyBatchInfo"

Polymorphic Discriminator

serializedName

serializedName: string = "PropertyBatchInfo"

type

type: object

className

className: string = "PropertyBatchInfo"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "PropertyBatchInfo"

modelProperties

modelProperties: object

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "Kind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "Kind"

Const PropertyBatchOperation

PropertyBatchOperation: object

Represents the base type for property operations that can be put into a batch and submitted.

kind

kind: "PropertyBatchOperation"

Polymorphic Discriminator

propertyName

propertyName: string

The name of the Service Fabric property.

serializedName

serializedName: string = "PropertyBatchOperation"

type

type: object

className

className: string = "PropertyBatchOperation"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "PropertyBatchOperation"

modelProperties

modelProperties: object

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "Kind"

type

type: object

name

name: "String" = "String"

propertyName

propertyName: object

required

required: true = true

serializedName

serializedName: string = "PropertyName"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "Kind"

Const PropertyDescription

PropertyDescription: object

Description of a Service Fabric property.

Optional customTypeId

customTypeId: undefined | string

The property's custom type ID. Using this property, the user is able to tag the type of the value of the property.

propertyName

propertyName: string

The name of the Service Fabric property.

value

Describes a Service Fabric property value.

serializedName

serializedName: string = "PropertyDescription"

type

type: object

className

className: string = "PropertyDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

customTypeId

customTypeId: object

serializedName

serializedName: string = "CustomTypeId"

type

type: object

name

name: "String" = "String"

propertyName

propertyName: object

required

required: true = true

serializedName

serializedName: string = "PropertyName"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "Value"

type

type: object

className

className: string = "PropertyValue"

name

name: "Composite" = "Composite"

Const PropertyInfo

PropertyInfo: object

Information about a Service Fabric property.

metadata

The metadata associated with a property, including the property's name.

name

name: string

The name of the Service Fabric property.

Optional value

Describes a Service Fabric property value.

serializedName

serializedName: string = "PropertyInfo"

type

type: object

className

className: string = "PropertyInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

metadata

metadata: object

required

required: true = true

serializedName

serializedName: string = "Metadata"

type

type: object

className

className: string = "PropertyMetadata"

name

name: "Composite" = "Composite"

name

name: object

required

required: true = true

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "Value"

type

type: object

className

className: string = "PropertyValue"

name

name: "Composite" = "Composite"

Const PropertyMetadata

PropertyMetadata: object

The metadata associated with a property, including the property's name.

Optional customTypeId

customTypeId: undefined | string

The property's custom type ID.

Optional lastModifiedUtcTimestamp

lastModifiedUtcTimestamp: Date

Represents when the Property was last modified. Only write operations will cause this field to be updated.

Optional parent

parent: undefined | string

The name of the parent Service Fabric Name for the property. It could be thought of as the name-space/table under which the property exists.

Optional sequenceNumber

sequenceNumber: undefined | string

The version of the property. Every time a property is modified, its sequence number is increased.

Optional sizeInBytes

sizeInBytes: undefined | number

The length of the serialized property value.

Optional typeId

The kind of property, determined by the type of data. Following are the possible values. Possible values include: 'Invalid', 'Binary', 'Int64', 'Double', 'String', 'Guid'

serializedName

serializedName: string = "PropertyMetadata"

type

type: object

className

className: string = "PropertyMetadata"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

customTypeId

customTypeId: object

serializedName

serializedName: string = "CustomTypeId"

type

type: object

name

name: "String" = "String"

lastModifiedUtcTimestamp

lastModifiedUtcTimestamp: object

serializedName

serializedName: string = "LastModifiedUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

parent

parent: object

serializedName

serializedName: string = "Parent"

type

type: object

name

name: "String" = "String"

sequenceNumber

sequenceNumber: object

serializedName

serializedName: string = "SequenceNumber"

type

type: object

name

name: "String" = "String"

sizeInBytes

sizeInBytes: object

serializedName

serializedName: string = "SizeInBytes"

type

type: object

name

name: "Number" = "Number"

typeId

typeId: object

serializedName

serializedName: string = "TypeId"

type

type: object

name

name: "String" = "String"

Const PropertyValue

PropertyValue: object

Describes a Service Fabric property value.

kind

kind: "PropertyValue"

Polymorphic Discriminator

serializedName

serializedName: string = "PropertyValue"

type

type: object

className

className: string = "PropertyValue"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "PropertyValue"

modelProperties

modelProperties: object

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "Kind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "Kind"

Const ProvisionApplicationTypeDescription

ProvisionApplicationTypeDescription: object

Describes the operation to register or provision an application type using an application package uploaded to the Service Fabric image store.

Optional applicationPackageCleanupPolicy

applicationPackageCleanupPolicy: ApplicationPackageCleanupPolicy

The kind of action that needs to be taken for cleaning up the application package after successful provision. Possible values include: 'Invalid', 'Default', 'Automatic', 'Manual'

applicationTypeBuildPath

applicationTypeBuildPath: string

The relative path for the application package in the image store specified during the prior upload operation.

async

async: boolean

Indicates whether or not provisioning should occur asynchronously. When set to true, the provision operation returns when the request is accepted by the system, and the provision operation continues without any timeout limit. The default value is false. For large application packages, we recommend setting the value to true.

kind

kind: "ImageStorePath"

Polymorphic Discriminator

serializedName

serializedName: string = "ImageStorePath"

type

type: object

className

className: string = "ProvisionApplicationTypeDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProvisionApplicationTypeDescriptionBase.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProvisionApplicationTypeDescriptionBase"

modelProperties

modelProperties: object

applicationPackageCleanupPolicy

applicationPackageCleanupPolicy: object

serializedName

serializedName: string = "ApplicationPackageCleanupPolicy"

type

type: object

name

name: "String" = "String"

applicationTypeBuildPath

applicationTypeBuildPath: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeBuildPath"

type

type: object

name

name: "String" = "String"

Const ProvisionApplicationTypeDescriptionBase

ProvisionApplicationTypeDescriptionBase: object

Represents the type of registration or provision requested, and if the operation needs to be asynchronous or not. Supported types of provision operations are from either image store or external store.

async

async: boolean

Indicates whether or not provisioning should occur asynchronously. When set to true, the provision operation returns when the request is accepted by the system, and the provision operation continues without any timeout limit. The default value is false. For large application packages, we recommend setting the value to true.

kind

kind: "ProvisionApplicationTypeDescriptionBase"

Polymorphic Discriminator

serializedName

serializedName: string = "ProvisionApplicationTypeDescriptionBase"

type

type: object

className

className: string = "ProvisionApplicationTypeDescriptionBase"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ProvisionApplicationTypeDescriptionBase"

modelProperties

modelProperties: object

async

async: object

required

required: true = true

serializedName

serializedName: string = "Async"

type

type: object

name

name: "Boolean" = "Boolean"

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "Kind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "Kind"

Const ProvisionFabricDescription

ProvisionFabricDescription: object

Describes the parameters for provisioning a cluster.

Optional clusterManifestFilePath

clusterManifestFilePath: undefined | string

The cluster manifest file path.

Optional codeFilePath

codeFilePath: undefined | string

The cluster code package file path.

serializedName

serializedName: string = "ProvisionFabricDescription"

type

type: object

className

className: string = "ProvisionFabricDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clusterManifestFilePath

clusterManifestFilePath: object

serializedName

serializedName: string = "ClusterManifestFilePath"

type

type: object

name

name: "String" = "String"

codeFilePath

codeFilePath: object

serializedName

serializedName: string = "CodeFilePath"

type

type: object

name

name: "String" = "String"

Const PutPropertyBatchOperation

PutPropertyBatchOperation: object

Puts the specified property under the specified name. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.

Optional customTypeId

customTypeId: undefined | string

The property's custom type ID. Using this property, the user is able to tag the type of the value of the property.

kind

kind: "Put"

Polymorphic Discriminator

propertyName

propertyName: string

The name of the Service Fabric property.

value

Describes a Service Fabric property value.

serializedName

serializedName: string = "Put"

type

type: object

className

className: string = "PutPropertyBatchOperation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PropertyBatchOperation.type.polymorphicDiscriminator

uberParent

uberParent: string = "PropertyBatchOperation"

modelProperties

modelProperties: object

customTypeId

customTypeId: object

serializedName

serializedName: string = "CustomTypeId"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "Value"

type

type: object

className

className: string = "PropertyValue"

name

name: "Composite" = "Composite"

Const ReconfigurationInformation

ReconfigurationInformation: object

Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time.

Optional previousConfigurationRole

previousConfigurationRole: ReplicaRole

Replica role before reconfiguration started. Possible values include: 'Unknown', 'None', 'Primary', 'IdleSecondary', 'ActiveSecondary'

Optional reconfigurationPhase

reconfigurationPhase: ReconfigurationPhase

Current phase of ongoing reconfiguration. If no reconfiguration is taking place then this value will be "None". Possible values include: 'Unknown', 'None', 'Phase0', 'Phase1', 'Phase2', 'Phase3', 'Phase4', 'AbortPhaseZero'

Optional reconfigurationStartTimeUtc

reconfigurationStartTimeUtc: Date

Start time (in UTC) of the ongoing reconfiguration. If no reconfiguration is taking place then this value will be zero date-time.

Optional reconfigurationType

reconfigurationType: ReconfigurationType

Type of current ongoing reconfiguration. If no reconfiguration is taking place then this value will be "None". Possible values include: 'Unknown', 'SwapPrimary', 'Failover', 'Other'

serializedName

serializedName: string = "ReconfigurationInformation"

type

type: object

className

className: string = "ReconfigurationInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

previousConfigurationRole

previousConfigurationRole: object

serializedName

serializedName: string = "PreviousConfigurationRole"

type

type: object

name

name: "String" = "String"

reconfigurationPhase

reconfigurationPhase: object

serializedName

serializedName: string = "ReconfigurationPhase"

type

type: object

name

name: "String" = "String"

reconfigurationStartTimeUtc

reconfigurationStartTimeUtc: object

serializedName

serializedName: string = "ReconfigurationStartTimeUtc"

type

type: object

name

name: "DateTime" = "DateTime"

reconfigurationType

reconfigurationType: object

serializedName

serializedName: string = "ReconfigurationType"

type

type: object

name

name: "String" = "String"

Const RegistryCredential

RegistryCredential: object

Credential information to connect to container registry.

Optional passwordEncrypted

passwordEncrypted: undefined | false | true

Indicates that supplied container registry password is encrypted.

Optional registryPassword

registryPassword: undefined | string

The password for supplied username to connect to container registry.

Optional registryUserName

registryUserName: undefined | string

The user name to connect to container registry.

serializedName

serializedName: string = "RegistryCredential"

type

type: object

className

className: string = "RegistryCredential"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

passwordEncrypted

passwordEncrypted: object

serializedName

serializedName: string = "PasswordEncrypted"

type

type: object

name

name: "Boolean" = "Boolean"

registryPassword

registryPassword: object

serializedName

serializedName: string = "RegistryPassword"

type

type: object

name

name: "String" = "String"

registryUserName

registryUserName: object

serializedName

serializedName: string = "RegistryUserName"

type

type: object

name

name: "String" = "String"

Const ReliableCollectionsRef

ReliableCollectionsRef: object

Specifying this parameter adds support for reliable collections

Optional doNotPersistState

doNotPersistState: undefined | false | true

False (the default) if ReliableCollections state is persisted to disk as usual. True if you do not want to persist state, in which case replication is still enabled and you can use ReliableCollections as distributed cache.

name

name: string

Name of ReliableCollection resource. Right now it's not used and you can use any string.

serializedName

serializedName: string = "ReliableCollectionsRef"

type

type: object

className

className: string = "ReliableCollectionsRef"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

doNotPersistState

doNotPersistState: object

serializedName

serializedName: string = "doNotPersistState"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const RemoteReplicatorAcknowledgementDetail

RemoteReplicatorAcknowledgementDetail: object

Provides various statistics of the acknowledgements that are being received from the remote replicator.

Optional averageApplyDuration

averageApplyDuration: undefined | string

Represents the average duration it takes for the remote replicator to apply an operation. This usually entails writing the operation to disk.

Optional averageReceiveDuration

averageReceiveDuration: undefined | string

Represents the average duration it takes for the remote replicator to receive an operation.

Optional notReceivedCount

notReceivedCount: undefined | string

Represents the number of operations not yet received by a remote replicator.

Optional receivedAndNotAppliedCount

receivedAndNotAppliedCount: undefined | string

Represents the number of operations received and not yet applied by a remote replicator.

serializedName

serializedName: string = "RemoteReplicatorAcknowledgementDetail"

type

type: object

className

className: string = "RemoteReplicatorAcknowledgementDetail"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

averageApplyDuration

averageApplyDuration: object

serializedName

serializedName: string = "AverageApplyDuration"

type

type: object

name

name: "String" = "String"

averageReceiveDuration

averageReceiveDuration: object

serializedName

serializedName: string = "AverageReceiveDuration"

type

type: object

name

name: "String" = "String"

notReceivedCount

notReceivedCount: object

serializedName

serializedName: string = "NotReceivedCount"

type

type: object

name

name: "String" = "String"

receivedAndNotAppliedCount

receivedAndNotAppliedCount: object

serializedName

serializedName: string = "ReceivedAndNotAppliedCount"

type

type: object

name

name: "String" = "String"

Const RemoteReplicatorAcknowledgementStatus

RemoteReplicatorAcknowledgementStatus: object

Provides details about the remote replicators from the primary replicator's point of view.

Optional copyStreamAcknowledgementDetail

copyStreamAcknowledgementDetail: RemoteReplicatorAcknowledgementDetail

Details about the acknowledgements for operations that are part of the copy stream data.

Optional replicationStreamAcknowledgementDetail

replicationStreamAcknowledgementDetail: RemoteReplicatorAcknowledgementDetail

Details about the acknowledgements for operations that are part of the replication stream data.

serializedName

serializedName: string = "RemoteReplicatorAcknowledgementStatus"

type

type: object

className

className: string = "RemoteReplicatorAcknowledgementStatus"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

copyStreamAcknowledgementDetail

copyStreamAcknowledgementDetail: object

serializedName

serializedName: string = "CopyStreamAcknowledgementDetail"

type

type: object

className

className: string = "RemoteReplicatorAcknowledgementDetail"

name

name: "Composite" = "Composite"

replicationStreamAcknowledgementDetail

replicationStreamAcknowledgementDetail: object

serializedName

serializedName: string = "ReplicationStreamAcknowledgementDetail"

type

type: object

className

className: string = "RemoteReplicatorAcknowledgementDetail"

name

name: "Composite" = "Composite"

Const RemoteReplicatorStatus

RemoteReplicatorStatus: object

Represents the state of the secondary replicator from the primary replicator’s point of view.

Optional isInBuild

isInBuild: undefined | false | true

A value that indicates whether the secondary replica is in the process of being built.

Optional lastAcknowledgementProcessedTimeUtc

lastAcknowledgementProcessedTimeUtc: Date

The last timestamp (in UTC) when an acknowledgement from the secondary replicator was processed on the primary. UTC 0 represents an invalid value, indicating that no acknowledgement messages were ever processed.

Optional lastAppliedCopySequenceNumber

lastAppliedCopySequenceNumber: undefined | string

The highest copy operation sequence number that the secondary has applied to its state. A value of -1 implies that the secondary has applied all copy operations and the copy process is complete.

Optional lastAppliedReplicationSequenceNumber

lastAppliedReplicationSequenceNumber: undefined | string

The highest replication operation sequence number that the secondary has applied to its state.

Optional lastReceivedCopySequenceNumber

lastReceivedCopySequenceNumber: undefined | string

The highest copy operation sequence number that the secondary has received from the primary. A value of -1 implies that the secondary has received all copy operations.

Optional lastReceivedReplicationSequenceNumber

lastReceivedReplicationSequenceNumber: undefined | string

The highest replication operation sequence number that the secondary has received from the primary.

Optional remoteReplicatorAcknowledgementStatus

remoteReplicatorAcknowledgementStatus: RemoteReplicatorAcknowledgementStatus

Represents the acknowledgment status for the remote secondary replicator.

Optional replicaId

replicaId: undefined | string

Represents the replica ID of the remote secondary replicator.

serializedName

serializedName: string = "RemoteReplicatorStatus"

type

type: object

className

className: string = "RemoteReplicatorStatus"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

isInBuild

isInBuild: object

serializedName

serializedName: string = "IsInBuild"

type

type: object

name

name: "Boolean" = "Boolean"

lastAcknowledgementProcessedTimeUtc

lastAcknowledgementProcessedTimeUtc: object

serializedName

serializedName: string = "LastAcknowledgementProcessedTimeUtc"

type

type: object

name

name: "DateTime" = "DateTime"

lastAppliedCopySequenceNumber

lastAppliedCopySequenceNumber: object

serializedName

serializedName: string = "LastAppliedCopySequenceNumber"

type

type: object

name

name: "String" = "String"

lastAppliedReplicationSequenceNumber

lastAppliedReplicationSequenceNumber: object

serializedName

serializedName: string = "LastAppliedReplicationSequenceNumber"

type

type: object

name

name: "String" = "String"

lastReceivedCopySequenceNumber

lastReceivedCopySequenceNumber: object

serializedName

serializedName: string = "LastReceivedCopySequenceNumber"

type

type: object

name

name: "String" = "String"

lastReceivedReplicationSequenceNumber

lastReceivedReplicationSequenceNumber: object

serializedName

serializedName: string = "LastReceivedReplicationSequenceNumber"

type

type: object

name

name: "String" = "String"

remoteReplicatorAcknowledgementStatus

remoteReplicatorAcknowledgementStatus: object

serializedName

serializedName: string = "RemoteReplicatorAcknowledgementStatus"

type

type: object

className

className: string = "RemoteReplicatorAcknowledgementStatus"

name

name: "Composite" = "Composite"

replicaId

replicaId: object

serializedName

serializedName: string = "ReplicaId"

type

type: object

name

name: "String" = "String"

Const RepairImpactDescriptionBase

RepairImpactDescriptionBase: object

Describes the expected impact of executing a repair task.

This type supports the Service Fabric platform; it is not meant to be used directly from your code.

kind

kind: "RepairImpactDescriptionBase"

Polymorphic Discriminator

serializedName

serializedName: string = "RepairImpactDescriptionBase"

type

type: object

className

className: string = "RepairImpactDescriptionBase"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "RepairImpactDescriptionBase"

modelProperties

modelProperties: object

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "Kind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "Kind"

Const RepairTargetDescriptionBase

RepairTargetDescriptionBase: object

Describes the entities targeted by a repair action.

This type supports the Service Fabric platform; it is not meant to be used directly from your code.

kind

kind: "RepairTargetDescriptionBase"

Polymorphic Discriminator

serializedName

serializedName: string = "RepairTargetDescriptionBase"

type

type: object

className

className: string = "RepairTargetDescriptionBase"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "RepairTargetDescriptionBase"

modelProperties

modelProperties: object

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "Kind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "Kind"

Const RepairTask

RepairTask: object

Represents a repair task, which includes information about what kind of repair was requested, what its progress is, and what its final result was.

This type supports the Service Fabric platform; it is not meant to be used directly from your code.

action

action: string

The requested repair action. Must be specified when the repair task is created, and is immutable once set.

Optional description

description: undefined | string

A description of the purpose of the repair task, or other informational details. May be set when the repair task is created, and is immutable once set.

Optional executor

executor: undefined | string

The name of the repair executor. Must be specified in Claimed and later states, and is immutable once set.

Optional executorData

executorData: undefined | string

A data string that the repair executor can use to store its internal state.

Optional flags

flags: undefined | number

A bitwise-OR of the following values, which gives additional details about the status of the repair task.

  • 1 - Cancellation of the repair has been requested
  • 2 - Abort of the repair has been requested
  • 4 - Approval of the repair was forced via client request

Optional history

An object that contains timestamps of the repair task's state transitions. These timestamps are updated by the system, and cannot be directly modified.

Optional impact

The impact object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair. Impact must be specified by the repair executor when transitioning to the Preparing state, and is immutable once set.

Optional performPreparingHealthCheck

performPreparingHealthCheck: undefined | false | true

A value to determine if health checks will be performed when the repair task enters the Preparing state.

Optional performRestoringHealthCheck

performRestoringHealthCheck: undefined | false | true

A value to determine if health checks will be performed when the repair task enters the Restoring state.

Optional preparingHealthCheckState

preparingHealthCheckState: RepairTaskHealthCheckState

The workflow state of the health check when the repair task is in the Preparing state. Possible values include: 'NotStarted', 'InProgress', 'Succeeded', 'Skipped', 'TimedOut'

Optional restoringHealthCheckState

restoringHealthCheckState: RepairTaskHealthCheckState

The workflow state of the health check when the repair task is in the Restoring state. Possible values include: 'NotStarted', 'InProgress', 'Succeeded', 'Skipped', 'TimedOut'

Optional resultCode

resultCode: undefined | number

A numeric value providing additional details about the result of the repair task execution. May be specified in the Restoring and later states, and is immutable once set.

Optional resultDetails

resultDetails: undefined | string

A string providing additional details about the result of the repair task execution. May be specified in the Restoring and later states, and is immutable once set.

Optional resultStatus

resultStatus: ResultStatus

A value describing the overall result of the repair task execution. Must be specified in the Restoring and later states, and is immutable once set. Possible values include: 'Invalid', 'Succeeded', 'Cancelled', 'Interrupted', 'Failed', 'Pending'

state

state: State

The workflow state of the repair task. Valid initial states are Created, Claimed, and Preparing. Possible values include: 'Invalid', 'Created', 'Claimed', 'Preparing', 'Approved', 'Executing', 'Restoring', 'Completed'

Optional target

The target object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair. May be set when the repair task is created, and is immutable once set.

taskId

taskId: string

The ID of the repair task.

Optional version

version: undefined | string

The version of the repair task. When creating a new repair task, the version must be set to zero. When updating a repair task, the version is used for optimistic concurrency checks. If the version is set to zero, the update will not check for write conflicts. If the version is set to a non-zero value, then the update will only succeed if the actual current version of the repair task matches this value.

serializedName

serializedName: string = "RepairTask"

type

type: object

className

className: string = "RepairTask"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

action

action: object

required

required: true = true

serializedName

serializedName: string = "Action"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "Description"

type

type: object

name

name: "String" = "String"

executor

executor: object

serializedName

serializedName: string = "Executor"

type

type: object

name

name: "String" = "String"

executorData

executorData: object

serializedName

serializedName: string = "ExecutorData"

type

type: object

name

name: "String" = "String"

flags

flags: object

serializedName

serializedName: string = "Flags"

type

type: object

name

name: "Number" = "Number"

history

history: object

serializedName

serializedName: string = "History"

type

type: object

className

className: string = "RepairTaskHistory"

name

name: "Composite" = "Composite"

impact

impact: object

serializedName

serializedName: string = "Impact"

type

type: object

className

className: string = "RepairImpactDescriptionBase"

name

name: "Composite" = "Composite"

performPreparingHealthCheck

performPreparingHealthCheck: object

serializedName

serializedName: string = "PerformPreparingHealthCheck"

type

type: object

name

name: "Boolean" = "Boolean"

performRestoringHealthCheck

performRestoringHealthCheck: object

serializedName

serializedName: string = "PerformRestoringHealthCheck"

type

type: object

name

name: "Boolean" = "Boolean"

preparingHealthCheckState

preparingHealthCheckState: object

serializedName

serializedName: string = "PreparingHealthCheckState"

type

type: object

name

name: "String" = "String"

restoringHealthCheckState

restoringHealthCheckState: object

serializedName

serializedName: string = "RestoringHealthCheckState"

type

type: object

name

name: "String" = "String"

resultCode

resultCode: object

serializedName

serializedName: string = "ResultCode"

type

type: object

name

name: "Number" = "Number"

resultDetails

resultDetails: object

serializedName

serializedName: string = "ResultDetails"

type

type: object

name

name: "String" = "String"

resultStatus

resultStatus: object

serializedName

serializedName: string = "ResultStatus"

type

type: object

name

name: "String" = "String"

state

state: object

required

required: true = true

serializedName

serializedName: string = "State"

type

type: object

name

name: "String" = "String"

target

target: object

serializedName

serializedName: string = "Target"

type

type: object

className

className: string = "RepairTargetDescriptionBase"

name

name: "Composite" = "Composite"

taskId

taskId: object

required

required: true = true

serializedName

serializedName: string = "TaskId"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "Version"

type

type: object

name

name: "String" = "String"

Const RepairTaskApproveDescription

RepairTaskApproveDescription: object

Describes a request for forced approval of a repair task.

This type supports the Service Fabric platform; it is not meant to be used directly from your code.

taskId

taskId: string

The ID of the repair task.

Optional version

version: undefined | string

The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed.

serializedName

serializedName: string = "RepairTaskApproveDescription"

type

type: object

className

className: string = "RepairTaskApproveDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

taskId

taskId: object

required

required: true = true

serializedName

serializedName: string = "TaskId"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "Version"

type

type: object

name

name: "String" = "String"

Const RepairTaskCancelDescription

RepairTaskCancelDescription: object

Describes a request to cancel a repair task.

This type supports the Service Fabric platform; it is not meant to be used directly from your code.

Optional requestAbort

requestAbort: undefined | false | true

True if the repair should be stopped as soon as possible even if it has already started executing. False if the repair should be cancelled only if execution has not yet started.

taskId

taskId: string

The ID of the repair task.

Optional version

version: undefined | string

The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed.

serializedName

serializedName: string = "RepairTaskCancelDescription"

type

type: object

className

className: string = "RepairTaskCancelDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

requestAbort

requestAbort: object

serializedName

serializedName: string = "RequestAbort"

type

type: object

name

name: "Boolean" = "Boolean"

taskId

taskId: object

required

required: true = true

serializedName

serializedName: string = "TaskId"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "Version"

type

type: object

name

name: "String" = "String"

Const RepairTaskDeleteDescription

RepairTaskDeleteDescription: object

Describes a request to delete a completed repair task.

This type supports the Service Fabric platform; it is not meant to be used directly from your code.

taskId

taskId: string

The ID of the completed repair task to be deleted.

Optional version

version: undefined | string

The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed.

serializedName

serializedName: string = "RepairTaskDeleteDescription"

type

type: object

className

className: string = "RepairTaskDeleteDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

taskId

taskId: object

required

required: true = true

serializedName

serializedName: string = "TaskId"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "Version"

type

type: object

name

name: "String" = "String"

Const RepairTaskHistory

RepairTaskHistory: object

A record of the times when the repair task entered each state.

This type supports the Service Fabric platform; it is not meant to be used directly from your code.

Optional approvedUtcTimestamp

approvedUtcTimestamp: Date

The time when the repair task entered the Approved state

Optional claimedUtcTimestamp

claimedUtcTimestamp: Date

The time when the repair task entered the Claimed state.

Optional completedUtcTimestamp

completedUtcTimestamp: Date

The time when the repair task entered the Completed state

Optional createdUtcTimestamp

createdUtcTimestamp: Date

The time when the repair task entered the Created state.

Optional executingUtcTimestamp

executingUtcTimestamp: Date

The time when the repair task entered the Executing state

Optional preparingHealthCheckEndUtcTimestamp

preparingHealthCheckEndUtcTimestamp: Date

The time when the repair task completed the health check in the Preparing state.

Optional preparingHealthCheckStartUtcTimestamp

preparingHealthCheckStartUtcTimestamp: Date

The time when the repair task started the health check in the Preparing state.

Optional preparingUtcTimestamp

preparingUtcTimestamp: Date

The time when the repair task entered the Preparing state.

Optional restoringHealthCheckEndUtcTimestamp

restoringHealthCheckEndUtcTimestamp: Date

The time when the repair task completed the health check in the Restoring state.

Optional restoringHealthCheckStartUtcTimestamp

restoringHealthCheckStartUtcTimestamp: Date

The time when the repair task started the health check in the Restoring state.

Optional restoringUtcTimestamp

restoringUtcTimestamp: Date

The time when the repair task entered the Restoring state

serializedName

serializedName: string = "RepairTaskHistory"

type

type: object

className

className: string = "RepairTaskHistory"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

approvedUtcTimestamp

approvedUtcTimestamp: object

serializedName

serializedName: string = "ApprovedUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

claimedUtcTimestamp

claimedUtcTimestamp: object

serializedName

serializedName: string = "ClaimedUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

completedUtcTimestamp

completedUtcTimestamp: object

serializedName

serializedName: string = "CompletedUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

createdUtcTimestamp

createdUtcTimestamp: object

serializedName

serializedName: string = "CreatedUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

executingUtcTimestamp

executingUtcTimestamp: object

serializedName

serializedName: string = "ExecutingUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

preparingHealthCheckEndUtcTimestamp

preparingHealthCheckEndUtcTimestamp: object

serializedName

serializedName: string = "PreparingHealthCheckEndUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

preparingHealthCheckStartUtcTimestamp

preparingHealthCheckStartUtcTimestamp: object

serializedName

serializedName: string = "PreparingHealthCheckStartUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

preparingUtcTimestamp

preparingUtcTimestamp: object

serializedName

serializedName: string = "PreparingUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

restoringHealthCheckEndUtcTimestamp

restoringHealthCheckEndUtcTimestamp: object

serializedName

serializedName: string = "RestoringHealthCheckEndUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

restoringHealthCheckStartUtcTimestamp

restoringHealthCheckStartUtcTimestamp: object

serializedName

serializedName: string = "RestoringHealthCheckStartUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

restoringUtcTimestamp

restoringUtcTimestamp: object

serializedName

serializedName: string = "RestoringUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

Const RepairTaskUpdateHealthPolicyDescription

RepairTaskUpdateHealthPolicyDescription: object

Describes a request to update the health policy of a repair task.

This type supports the Service Fabric platform; it is not meant to be used directly from your code.

Optional performPreparingHealthCheck

performPreparingHealthCheck: undefined | false | true

A boolean indicating if health check is to be performed in the Preparing stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value.

Optional performRestoringHealthCheck

performRestoringHealthCheck: undefined | false | true

A boolean indicating if health check is to be performed in the Restoring stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value.

taskId

taskId: string

The ID of the repair task to be updated.

Optional version

version: undefined | string

The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current value of the repair task. If zero, then no version check is performed.

serializedName

serializedName: string = "RepairTaskUpdateHealthPolicyDescription"

type

type: object

className

className: string = "RepairTaskUpdateHealthPolicyDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

performPreparingHealthCheck

performPreparingHealthCheck: object

serializedName

serializedName: string = "PerformPreparingHealthCheck"

type

type: object

name

name: "Boolean" = "Boolean"

performRestoringHealthCheck

performRestoringHealthCheck: object

serializedName

serializedName: string = "PerformRestoringHealthCheck"

type

type: object

name

name: "Boolean" = "Boolean"

taskId

taskId: object

required

required: true = true

serializedName

serializedName: string = "TaskId"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "Version"

type

type: object

name

name: "String" = "String"

Const RepairTaskUpdateInfo

RepairTaskUpdateInfo: object

Describes the result of an operation that created or updated a repair task.

This type supports the Service Fabric platform; it is not meant to be used directly from your code.

version

version: string

The new version of the repair task.

serializedName

serializedName: string = "RepairTaskUpdateInfo"

type

type: object

className

className: string = "RepairTaskUpdateInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

version

version: object

required

required: true = true

serializedName

serializedName: string = "Version"

type

type: object

name

name: "String" = "String"

Const ReplicaEvent

ReplicaEvent: object

Represents the base for all Replica Events.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ReplicaEvent"

Polymorphic Discriminator

partitionId

partitionId: string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

replicaId

replicaId: number

Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ReplicaEvent"

type

type: object

className

className: string = "ReplicaEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

partitionId

partitionId: object

required

required: true = true

serializedName

serializedName: string = "PartitionId"

type

type: object

name

name: "Uuid" = "Uuid"

replicaId

replicaId: object

required

required: true = true

serializedName

serializedName: string = "ReplicaId"

type

type: object

name

name: "Number" = "Number"

Const ReplicaHealth

ReplicaHealth: object

Represents a base class for stateful service replica or stateless service instance health. Contains the replica aggregated health state, the health events and the unhealthy evaluations.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional healthEvents

healthEvents: HealthEvent[]

The list of health events reported on the entity.

Optional healthStatistics

healthStatistics: HealthStatistics

Shows the health statistics for all children types of the queried entity.

Optional partitionId

partitionId: undefined | string

Id of the partition to which this replica belongs.

serviceKind

serviceKind: "ReplicaHealth"

Polymorphic Discriminator

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.

serializedName

serializedName: string = "ReplicaHealth"

type

type: object

className

className: string = "ReplicaHealth"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ReplicaHealth"

modelProperties

modelProperties: object

partitionId

partitionId: object

serializedName

serializedName: string = "PartitionId"

type

type: object

name

name: "Uuid" = "Uuid"

serviceKind

serviceKind: object

required

required: true = true

serializedName

serializedName: string = "ServiceKind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "serviceKind"

serializedName

serializedName: string = "ServiceKind"

Const ReplicaHealthEvaluation

ReplicaHealthEvaluation: object

Represents health evaluation for a replica, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional description

description: undefined | string

Description of the health evaluation, which represents a summary of the evaluation process.

kind

kind: "Replica"

Polymorphic Discriminator

Optional partitionId

partitionId: undefined | string

Id of the partition to which the replica belongs.

Optional replicaOrInstanceId

replicaOrInstanceId: undefined | string

Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

List of unhealthy evaluations that led to the current aggregated health state of the replica. The types of the unhealthy evaluations can be EventHealthEvaluation.

serializedName

serializedName: string = "Replica"

type

type: object

className

className: string = "ReplicaHealthEvaluation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = HealthEvaluation.type.polymorphicDiscriminator

uberParent

uberParent: string = "HealthEvaluation"

modelProperties

modelProperties: object

partitionId

partitionId: object

serializedName

serializedName: string = "PartitionId"

type

type: object

name

name: "Uuid" = "Uuid"

replicaOrInstanceId

replicaOrInstanceId: object

serializedName

serializedName: string = "ReplicaOrInstanceId"

type

type: object

name

name: "String" = "String"

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

Const ReplicaHealthState

ReplicaHealthState: object

Represents a base class for stateful service replica or stateless service instance health state.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional partitionId

partitionId: undefined | string

The ID of the partition to which this replica belongs.

serviceKind

serviceKind: "ReplicaHealthState"

Polymorphic Discriminator

serializedName

serializedName: string = "ReplicaHealthState"

type

type: object

className

className: string = "ReplicaHealthState"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ReplicaHealthState"

modelProperties

modelProperties: object

partitionId

partitionId: object

serializedName

serializedName: string = "PartitionId"

type

type: object

name

name: "Uuid" = "Uuid"

serviceKind

serviceKind: object

required

required: true = true

serializedName

serializedName: string = "ServiceKind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "serviceKind"

serializedName

serializedName: string = "ServiceKind"

Const ReplicaHealthStateChunk

ReplicaHealthStateChunk: object

Represents the health state chunk of a stateful service replica or a stateless service instance. The replica health state contains the replica ID and its aggregated health state.

Optional healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional replicaOrInstanceId

replicaOrInstanceId: undefined | string

Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID.

serializedName

serializedName: string = "ReplicaHealthStateChunk"

type

type: object

className

className: string = "ReplicaHealthStateChunk"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

replicaOrInstanceId

replicaOrInstanceId: object

serializedName

serializedName: string = "ReplicaOrInstanceId"

type

type: object

name

name: "String" = "String"

Const ReplicaHealthStateChunkList

ReplicaHealthStateChunkList: object

The list of replica health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.

Optional items

The list of replica health state chunks that respect the input filters in the chunk query.

serializedName

serializedName: string = "ReplicaHealthStateChunkList"

type

type: object

className

className: string = "ReplicaHealthStateChunkList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ReplicaHealthStateChunk"

name

name: "Composite" = "Composite"

Const ReplicaHealthStateFilter

ReplicaHealthStateFilter: object

Defines matching criteria to determine whether a replica should be included as a child of a partition in the cluster health chunk. The replicas are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent partition, service and application must be included in the cluster health chunk. One filter can match zero, one or multiple replicas, depending on its properties.

Optional healthStateFilter

healthStateFilter: undefined | number

The filter for the health state of the replicas. It allows selecting replicas if they match the desired health states. The possible values are integer value of one of the following health states. Only replicas that match the filter are returned. All replicas are used to evaluate the parent partition aggregated health state. If not specified, default value is None, unless the replica ID is specified. If the filter has default value and replica ID is specified, the matching replica is returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6, it matches replicas with HealthState value of OK (2) and Warning (4).

  • Default - Default value. Matches any HealthState. The value is zero.
  • None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.
  • Ok - Filter that matches input with HealthState value Ok. The value is 2.
  • Warning - Filter that matches input with HealthState value Warning. The value is 4.
  • Error - Filter that matches input with HealthState value Error. The value is 8.
  • All - Filter that matches input with any HealthState value. The value is 65535. Default value: 0.

Optional replicaOrInstanceIdFilter

replicaOrInstanceIdFilter: undefined | string

Id of the stateful service replica or stateless service instance that matches the filter. The filter is applied only to the specified replica, if it exists. If the replica doesn't exist, no replica is returned in the cluster health chunk based on this filter. If the replica exists, it is included in the cluster health chunk if it respects the other filter properties. If not specified, all replicas that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.

serializedName

serializedName: string = "ReplicaHealthStateFilter"

type

type: object

className

className: string = "ReplicaHealthStateFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

healthStateFilter

healthStateFilter: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "HealthStateFilter"

type

type: object

name

name: "Number" = "Number"

replicaOrInstanceIdFilter

replicaOrInstanceIdFilter: object

serializedName

serializedName: string = "ReplicaOrInstanceIdFilter"

type

type: object

name

name: "String" = "String"

Const ReplicaInfo

ReplicaInfo: object

Information about the identity, status, health, node name, uptime, and other details about the replica.

Optional address

address: undefined | string

The address the replica is listening on.

Optional healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional lastInBuildDurationInSeconds

lastInBuildDurationInSeconds: undefined | string

The last in build duration of the replica in seconds.

Optional nodeName

nodeName: undefined | string

The name of a Service Fabric node.

Optional replicaStatus

replicaStatus: ReplicaStatus

The status of a replica of a service. Possible values include: 'Invalid', 'InBuild', 'Standby', 'Ready', 'Down', 'Dropped'

serviceKind

serviceKind: "ReplicaInfo"

Polymorphic Discriminator

serializedName

serializedName: string = "ReplicaInfo"

type

type: object

className

className: string = "ReplicaInfo"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ReplicaInfo"

modelProperties

modelProperties: object

address

address: object

serializedName

serializedName: string = "Address"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

lastInBuildDurationInSeconds

lastInBuildDurationInSeconds: object

serializedName

serializedName: string = "LastInBuildDurationInSeconds"

type

type: object

name

name: "String" = "String"

nodeName

nodeName: object

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

replicaStatus

replicaStatus: object

serializedName

serializedName: string = "ReplicaStatus"

type

type: object

name

name: "String" = "String"

serviceKind

serviceKind: object

required

required: true = true

serializedName

serializedName: string = "ServiceKind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "serviceKind"

serializedName

serializedName: string = "ServiceKind"

Const ReplicaStatusBase

ReplicaStatusBase: object

Information about the replica.

kind

kind: "ReplicaStatusBase"

Polymorphic Discriminator

serializedName

serializedName: string = "ReplicaStatusBase"

type

type: object

className

className: string = "ReplicaStatusBase"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ReplicaStatusBase"

modelProperties

modelProperties: object

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "Kind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "Kind"

Const ReplicasHealthEvaluation

ReplicasHealthEvaluation: object

Represents health evaluation for replicas, containing health evaluations for each unhealthy replica that impacted current aggregated health state. Can be returned when evaluating partition health and the aggregated health state is either Error or Warning.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional description

description: undefined | string

Description of the health evaluation, which represents a summary of the evaluation process.

kind

kind: "Replicas"

Polymorphic Discriminator

Optional maxPercentUnhealthyReplicasPerPartition

maxPercentUnhealthyReplicasPerPartition: undefined | number

Maximum allowed percentage of unhealthy replicas per partition from the ApplicationHealthPolicy.

Optional totalCount

totalCount: undefined | number

Total number of replicas in the partition from the health store.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ReplicaHealthEvaluation that impacted the aggregated health.

serializedName

serializedName: string = "Replicas"

type

type: object

className

className: string = "ReplicasHealthEvaluation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = HealthEvaluation.type.polymorphicDiscriminator

uberParent

uberParent: string = "HealthEvaluation"

modelProperties

modelProperties: object

maxPercentUnhealthyReplicasPerPartition

maxPercentUnhealthyReplicasPerPartition: object

serializedName

serializedName: string = "MaxPercentUnhealthyReplicasPerPartition"

type

type: object

name

name: "Number" = "Number"

totalCount

totalCount: object

serializedName

serializedName: string = "TotalCount"

type

type: object

name

name: "Number" = "Number"

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

Const ReplicatorQueueStatus

ReplicatorQueueStatus: object

Provides various statistics of the queue used in the service fabric replicator. Contains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc. Depending on the role of the replicator, the properties in this type imply different meanings.

Optional committedSequenceNumber

committedSequenceNumber: undefined | string

On a primary replicator, this is semantically the highest sequence number of the operation for which a write quorum of the secondary replicas have sent an acknowledgement. On a secondary replicator, this is semantically the highest sequence number of the in-order operation received from the primary.

Optional completedSequenceNumber

completedSequenceNumber: undefined | string

On a primary replicator, this is semantically the highest sequence number of the operation for which all the secondary replicas have sent an acknowledgement. On a secondary replicator, this is semantically the highest sequence number that has been applied to the persistent state.

Optional firstSequenceNumber

firstSequenceNumber: undefined | string

On a primary replicator, this is semantically the sequence number of the operation for which all the secondary replicas have sent an acknowledgement. On a secondary replicator, this is the smallest sequence number of the operation that is present in the queue.

Optional lastSequenceNumber

lastSequenceNumber: undefined | string

Represents the latest sequence number of the operation that is available in the queue.

Optional queueMemorySize

queueMemorySize: undefined | string

Represents the virtual memory consumed by the queue in bytes.

Optional queueUtilizationPercentage

queueUtilizationPercentage: undefined | number

Represents the utilization of the queue. A value of 0 indicates that the queue is empty and a value of 100 indicates the queue is full.

serializedName

serializedName: string = "ReplicatorQueueStatus"

type

type: object

className

className: string = "ReplicatorQueueStatus"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

committedSequenceNumber

committedSequenceNumber: object

serializedName

serializedName: string = "CommittedSequenceNumber"

type

type: object

name

name: "String" = "String"

completedSequenceNumber

completedSequenceNumber: object

serializedName

serializedName: string = "CompletedSequenceNumber"

type

type: object

name

name: "String" = "String"

firstSequenceNumber

firstSequenceNumber: object

serializedName

serializedName: string = "FirstSequenceNumber"

type

type: object

name

name: "String" = "String"

lastSequenceNumber

lastSequenceNumber: object

serializedName

serializedName: string = "LastSequenceNumber"

type

type: object

name

name: "String" = "String"

queueMemorySize

queueMemorySize: object

serializedName

serializedName: string = "QueueMemorySize"

type

type: object

name

name: "String" = "String"

queueUtilizationPercentage

queueUtilizationPercentage: object

serializedName

serializedName: string = "QueueUtilizationPercentage"

type

type: object

name

name: "Number" = "Number"

Const ReplicatorStatus

ReplicatorStatus: object

Represents a base class for primary or secondary replicator status. Contains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc.

kind

kind: "ReplicatorStatus"

Polymorphic Discriminator

serializedName

serializedName: string = "ReplicatorStatus"

type

type: object

className

className: string = "ReplicatorStatus"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ReplicatorStatus"

modelProperties

modelProperties: object

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "Kind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "Kind"

Const ResolvedServiceEndpoint

ResolvedServiceEndpoint: object

Endpoint of a resolved service partition.

Optional address

address: undefined | string

The address of the endpoint. If the endpoint has multiple listeners the address is a JSON object with one property per listener with the value as the address of that listener.

Optional kind

The role of the replica where the endpoint is reported. Possible values include: 'Invalid', 'Stateless', 'StatefulPrimary', 'StatefulSecondary'

serializedName

serializedName: string = "ResolvedServiceEndpoint"

type

type: object

className

className: string = "ResolvedServiceEndpoint"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

address

address: object

serializedName

serializedName: string = "Address"

type

type: object

name

name: "String" = "String"

kind

kind: object

serializedName

serializedName: string = "Kind"

type

type: object

name

name: "String" = "String"

Const ResolvedServicePartition

ResolvedServicePartition: object

Information about a service partition and its associated endpoints.

endpoints

List of resolved service endpoints of a service partition.

name

name: string

The full name of the service with 'fabric:' URI scheme.

partitionInformation

partitionInformation: PartitionInformationUnion

A representation of the resolved partition.

version

version: string

The version of this resolved service partition result. This version should be passed in the next time the ResolveService call is made via the PreviousRspVersion query parameter.

serializedName

serializedName: string = "ResolvedServicePartition"

type

type: object

className

className: string = "ResolvedServicePartition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endpoints

endpoints: object

required

required: true = true

serializedName

serializedName: string = "Endpoints"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResolvedServiceEndpoint"

name

name: "Composite" = "Composite"

name

name: object

required

required: true = true

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

partitionInformation

partitionInformation: object

required

required: true = true

serializedName

serializedName: string = "PartitionInformation"

type

type: object

className

className: string = "PartitionInformation"

name

name: "Composite" = "Composite"

version

version: object

required

required: true = true

serializedName

serializedName: string = "Version"

type

type: object

name

name: "String" = "String"

Const ResourceLimits

ResourceLimits: object

This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted.

Optional cpu

cpu: undefined | number

CPU limits in cores. At present, only full cores are supported.

Optional memoryInGB

memoryInGB: undefined | number

The memory limit in GB.

serializedName

serializedName: string = "ResourceLimits"

type

type: object

className

className: string = "ResourceLimits"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

cpu

cpu: object

serializedName

serializedName: string = "cpu"

type

type: object

name

name: "Number" = "Number"

memoryInGB

memoryInGB: object

serializedName

serializedName: string = "memoryInGB"

type

type: object

name

name: "Number" = "Number"

Const ResourceRequests

ResourceRequests: object

This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits.

cpu

cpu: number

Requested number of CPU cores. At present, only full cores are supported.

memoryInGB

memoryInGB: number

The memory request in GB for this container.

serializedName

serializedName: string = "ResourceRequests"

type

type: object

className

className: string = "ResourceRequests"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

cpu

cpu: object

required

required: true = true

serializedName

serializedName: string = "cpu"

type

type: object

name

name: "Number" = "Number"

memoryInGB

memoryInGB: object

required

required: true = true

serializedName

serializedName: string = "memoryInGB"

type

type: object

name

name: "Number" = "Number"

Const ResourceRequirements

ResourceRequirements: object

This type describes the resource requirements for a container or a service.

Optional limits

Describes the maximum limits on the resources for a given container.

requests

Describes the requested resources for a given container.

serializedName

serializedName: string = "ResourceRequirements"

type

type: object

className

className: string = "ResourceRequirements"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

limits

limits: object

serializedName

serializedName: string = "limits"

type

type: object

className

className: string = "ResourceLimits"

name

name: "Composite" = "Composite"

requests

requests: object

required

required: true = true

serializedName

serializedName: string = "requests"

type

type: object

className

className: string = "ResourceRequests"

name

name: "Composite" = "Composite"

Const RestartDeployedCodePackageDescription

RestartDeployedCodePackageDescription: object

Defines description for restarting a deployed code package on Service Fabric node.

codePackageInstanceId

codePackageInstanceId: string

The instance ID for currently running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance ID will change. If 0 is passed in as the code package instance ID, the API will restart the code package with whatever instance ID it is currently running. If an instance ID other than 0 is passed in, the API will restart the code package only if the current Instance ID matches the passed in instance ID. Note, passing in the exact instance ID (not 0) in the API is safer, because if ensures at most one restart of the code package.

codePackageName

codePackageName: string

The name of the code package defined in the service manifest.

serviceManifestName

serviceManifestName: string

The name of service manifest that specified this code package.

Optional servicePackageActivationId

servicePackageActivationId: undefined | string

The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.

serializedName

serializedName: string = "RestartDeployedCodePackageDescription"

type

type: object

className

className: string = "RestartDeployedCodePackageDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

codePackageInstanceId

codePackageInstanceId: object

required

required: true = true

serializedName

serializedName: string = "CodePackageInstanceId"

type

type: object

name

name: "String" = "String"

codePackageName

codePackageName: object

required

required: true = true

serializedName

serializedName: string = "CodePackageName"

type

type: object

name

name: "String" = "String"

serviceManifestName

serviceManifestName: object

required

required: true = true

serializedName

serializedName: string = "ServiceManifestName"

type

type: object

name

name: "String" = "String"

servicePackageActivationId

servicePackageActivationId: object

serializedName

serializedName: string = "ServicePackageActivationId"

type

type: object

name

name: "String" = "String"

Const RestartNodeDescription

RestartNodeDescription: object

Describes the parameters to restart a Service Fabric node.

Optional createFabricDump

createFabricDump: CreateFabricDump

Specify True to create a dump of the fabric node process. This is case-sensitive. Possible values include: 'False', 'True'. Default value: 'False'.

nodeInstanceId

nodeInstanceId: string

The instance ID of the target node. If instance ID is specified the node is restarted only if it matches with the current instance of the node. A default value of "0" would match any instance ID. The instance ID can be obtained using get node query. Default value: '0'.

serializedName

serializedName: string = "RestartNodeDescription"

type

type: object

className

className: string = "RestartNodeDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

createFabricDump

createFabricDump: object

defaultValue

defaultValue: string = "False"

serializedName

serializedName: string = "CreateFabricDump"

type

type: object

name

name: "String" = "String"

nodeInstanceId

nodeInstanceId: object

defaultValue

defaultValue: string = "0"

required

required: true = true

serializedName

serializedName: string = "NodeInstanceId"

type

type: object

name

name: "String" = "String"

Const RestartPartitionResult

RestartPartitionResult: object

Represents information about an operation in a terminal state (Completed or Faulted).

Optional errorCode

errorCode: undefined | number

If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason.

Optional selectedPartition

selectedPartition: SelectedPartition

This class returns information about the partition that the user-induced operation acted upon.

serializedName

serializedName: string = "RestartPartitionResult"

type

type: object

className

className: string = "RestartPartitionResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "ErrorCode"

type

type: object

name

name: "Number" = "Number"

selectedPartition

selectedPartition: object

serializedName

serializedName: string = "SelectedPartition"

type

type: object

className

className: string = "SelectedPartition"

name

name: "Composite" = "Composite"

Const RestorePartitionDescription

RestorePartitionDescription: object

Specifies the parameters needed to trigger a restore of a specific partition.

backupId

backupId: string

Unique backup ID.

backupLocation

backupLocation: string

Location of the backup relative to the backup storage specified/ configured.

Optional backupStorage

Location of the backup from where the partition will be restored.

serializedName

serializedName: string = "RestorePartitionDescription"

type

type: object

className

className: string = "RestorePartitionDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupId

backupId: object

required

required: true = true

serializedName

serializedName: string = "BackupId"

type

type: object

name

name: "Uuid" = "Uuid"

backupLocation

backupLocation: object

required

required: true = true

serializedName

serializedName: string = "BackupLocation"

type

type: object

name

name: "String" = "String"

backupStorage

backupStorage: object

serializedName

serializedName: string = "BackupStorage"

type

type: object

className

className: string = "BackupStorageDescription"

name

name: "Composite" = "Composite"

Const RestoreProgressInfo

RestoreProgressInfo: object

Describes the progress of a restore operation on a partition.

Optional failureError

failureError: FabricErrorError

Denotes the failure encountered in performing restore operation.

Optional restoreState

restoreState: RestoreState

Represents the current state of the partition restore operation. Possible values include: 'Invalid', 'Accepted', 'RestoreInProgress', 'Success', 'Failure', 'Timeout'

Optional restoredEpoch

restoredEpoch: Epoch

Describes the epoch at which the partition is restored.

Optional restoredLsn

restoredLsn: undefined | string

Restored LSN.

Optional timeStampUtc

timeStampUtc: Date

Timestamp when operation succeeded or failed.

serializedName

serializedName: string = "RestoreProgressInfo"

type

type: object

className

className: string = "RestoreProgressInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

failureError

failureError: object

serializedName

serializedName: string = "FailureError"

type

type: object

className

className: string = "FabricErrorError"

name

name: "Composite" = "Composite"

restoreState

restoreState: object

serializedName

serializedName: string = "RestoreState"

type

type: object

name

name: "String" = "String"

restoredEpoch

restoredEpoch: object

serializedName

serializedName: string = "RestoredEpoch"

type

type: object

className

className: string = "Epoch"

name

name: "Composite" = "Composite"

restoredLsn

restoredLsn: object

serializedName

serializedName: string = "RestoredLsn"

type

type: object

name

name: "String" = "String"

timeStampUtc

timeStampUtc: object

serializedName

serializedName: string = "TimeStampUtc"

type

type: object

name

name: "DateTime" = "DateTime"

Const ResumeApplicationUpgradeDescription

ResumeApplicationUpgradeDescription: object

Describes the parameters for resuming an unmonitored manual Service Fabric application upgrade

upgradeDomainName

upgradeDomainName: string

The name of the upgrade domain in which to resume the upgrade.

serializedName

serializedName: string = "ResumeApplicationUpgradeDescription"

type

type: object

className

className: string = "ResumeApplicationUpgradeDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

upgradeDomainName

upgradeDomainName: object

required

required: true = true

serializedName

serializedName: string = "UpgradeDomainName"

type

type: object

name

name: "String" = "String"

Const ResumeClusterUpgradeDescription

ResumeClusterUpgradeDescription: object

Describes the parameters for resuming a cluster upgrade.

upgradeDomain

upgradeDomain: string

The next upgrade domain for this cluster upgrade.

serializedName

serializedName: string = "ResumeClusterUpgradeDescription"

type

type: object

className

className: string = "ResumeClusterUpgradeDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

upgradeDomain

upgradeDomain: object

required

required: true = true

serializedName

serializedName: string = "UpgradeDomain"

type

type: object

name

name: "String" = "String"

Const RetentionPolicyDescription

RetentionPolicyDescription: object

Describes the retention policy configured.

retentionPolicyType

retentionPolicyType: "RetentionPolicyDescription"

Polymorphic Discriminator

serializedName

serializedName: string = "RetentionPolicyDescription"

type

type: object

className

className: string = "RetentionPolicyDescription"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "RetentionPolicyDescription"

modelProperties

modelProperties: object

retentionPolicyType

retentionPolicyType: object

required

required: true = true

serializedName

serializedName: string = "RetentionPolicyType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "retentionPolicyType"

serializedName

serializedName: string = "RetentionPolicyType"

Const RollingUpgradeUpdateDescription

RollingUpgradeUpdateDescription: object

Describes the parameters for updating a rolling upgrade of application or cluster.

Optional failureAction

failureAction: FailureAction

The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. Possible values include: 'Invalid', 'Rollback', 'Manual'

Optional forceRestart

forceRestart: undefined | false | true

If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).

Optional healthCheckRetryTimeoutInMilliseconds

healthCheckRetryTimeoutInMilliseconds: undefined | string

The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

Optional healthCheckStableDurationInMilliseconds

healthCheckStableDurationInMilliseconds: undefined | string

The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

Optional healthCheckWaitDurationInMilliseconds

healthCheckWaitDurationInMilliseconds: undefined | string

The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

Optional replicaSetCheckTimeoutInMilliseconds

replicaSetCheckTimeoutInMilliseconds: undefined | number

The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).

rollingUpgradeMode

rollingUpgradeMode: UpgradeMode

The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Default value: 'UnmonitoredAuto'.

Optional upgradeDomainTimeoutInMilliseconds

upgradeDomainTimeoutInMilliseconds: undefined | string

The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

Optional upgradeTimeoutInMilliseconds

upgradeTimeoutInMilliseconds: undefined | string

The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

serializedName

serializedName: string = "RollingUpgradeUpdateDescription"

type

type: object

className

className: string = "RollingUpgradeUpdateDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

failureAction

failureAction: object

serializedName

serializedName: string = "FailureAction"

type

type: object

name

name: "String" = "String"

forceRestart

forceRestart: object

serializedName

serializedName: string = "ForceRestart"

type

type: object

name

name: "Boolean" = "Boolean"

healthCheckRetryTimeoutInMilliseconds

healthCheckRetryTimeoutInMilliseconds: object

serializedName

serializedName: string = "HealthCheckRetryTimeoutInMilliseconds"

type

type: object

name

name: "String" = "String"

healthCheckStableDurationInMilliseconds

healthCheckStableDurationInMilliseconds: object

serializedName

serializedName: string = "HealthCheckStableDurationInMilliseconds"

type

type: object

name

name: "String" = "String"

healthCheckWaitDurationInMilliseconds

healthCheckWaitDurationInMilliseconds: object

serializedName

serializedName: string = "HealthCheckWaitDurationInMilliseconds"

type

type: object

name

name: "String" = "String"

replicaSetCheckTimeoutInMilliseconds

replicaSetCheckTimeoutInMilliseconds: object

serializedName

serializedName: string = "ReplicaSetCheckTimeoutInMilliseconds"

type

type: object

name

name: "Number" = "Number"

rollingUpgradeMode

rollingUpgradeMode: object

defaultValue

defaultValue: string = "UnmonitoredAuto"

required

required: true = true

serializedName

serializedName: string = "RollingUpgradeMode"

type

type: object

name

name: "String" = "String"

upgradeDomainTimeoutInMilliseconds

upgradeDomainTimeoutInMilliseconds: object

serializedName

serializedName: string = "UpgradeDomainTimeoutInMilliseconds"

type

type: object

name

name: "String" = "String"

upgradeTimeoutInMilliseconds

upgradeTimeoutInMilliseconds: object

serializedName

serializedName: string = "UpgradeTimeoutInMilliseconds"

type

type: object

name

name: "String" = "String"

Const SafetyCheck

SafetyCheck: object

Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.

kind

kind: "SafetyCheck"

Polymorphic Discriminator

serializedName

serializedName: string = "SafetyCheck"

type

type: object

className

className: string = "SafetyCheck"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "SafetyCheck"

modelProperties

modelProperties: object

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "Kind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "Kind"

Const SafetyCheckWrapper

SafetyCheckWrapper: object

A wrapper for the safety check object. Safety checks are performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.

Optional safetyCheck

safetyCheck: SafetyCheckUnion

Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.

serializedName

serializedName: string = "SafetyCheckWrapper"

type

type: object

className

className: string = "SafetyCheckWrapper"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

safetyCheck

safetyCheck: object

serializedName

serializedName: string = "SafetyCheck"

type

type: object

className

className: string = "SafetyCheck"

name

name: "Composite" = "Composite"

Const ScalingMechanismDescription

ScalingMechanismDescription: object

Describes the mechanism for performing a scaling operation.

kind

kind: "ScalingMechanismDescription"

Polymorphic Discriminator

serializedName

serializedName: string = "ScalingMechanismDescription"

type

type: object

className

className: string = "ScalingMechanismDescription"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ScalingMechanismDescription"

modelProperties

modelProperties: object

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "Kind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "Kind"

Const ScalingPolicyDescription

ScalingPolicyDescription: object

Describes how the scaling should be performed

scalingMechanism

Specifies the mechanism associated with this scaling policy

scalingTrigger

Specifies the trigger associated with this scaling policy

serializedName

serializedName: string = "ScalingPolicyDescription"

type

type: object

className

className: string = "ScalingPolicyDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

scalingMechanism

scalingMechanism: object

required

required: true = true

serializedName

serializedName: string = "ScalingMechanism"

type

type: object

className

className: string = "ScalingMechanismDescription"

name

name: "Composite" = "Composite"

scalingTrigger

scalingTrigger: object

required

required: true = true

serializedName

serializedName: string = "ScalingTrigger"

type

type: object

className

className: string = "ScalingTriggerDescription"

name

name: "Composite" = "Composite"

Const ScalingTriggerDescription

ScalingTriggerDescription: object

Describes the trigger for performing a scaling operation.

kind

kind: "ScalingTriggerDescription"

Polymorphic Discriminator

serializedName

serializedName: string = "ScalingTriggerDescription"

type

type: object

className

className: string = "ScalingTriggerDescription"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ScalingTriggerDescription"

modelProperties

modelProperties: object

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "Kind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "Kind"

Const SecondaryActiveReplicatorStatus

SecondaryActiveReplicatorStatus: object

Status of the secondary replicator when it is in active mode and is part of the replica set.

Optional copyQueueStatus

copyQueueStatus: ReplicatorQueueStatus

Details about the copy queue on the secondary replicator.

Optional isInBuild

isInBuild: undefined | false | true

Value that indicates whether the replica is currently being built.

kind

kind: "ActiveSecondary"

Polymorphic Discriminator

Optional lastAcknowledgementSentTimeUtc

lastAcknowledgementSentTimeUtc: Date

The last time-stamp (UTC) at which an acknowledgment was sent to the primary replicator. UTC 0 represents an invalid value, indicating that an acknowledgment message was never sent.

Optional lastCopyOperationReceivedTimeUtc

lastCopyOperationReceivedTimeUtc: Date

The last time-stamp (UTC) at which a copy operation was received from the primary. UTC 0 represents an invalid value, indicating that a copy operation message was never received.

Optional lastReplicationOperationReceivedTimeUtc

lastReplicationOperationReceivedTimeUtc: Date

The last time-stamp (UTC) at which a replication operation was received from the primary. UTC 0 represents an invalid value, indicating that a replication operation message was never received.

Optional replicationQueueStatus

replicationQueueStatus: ReplicatorQueueStatus

Details about the replication queue on the secondary replicator.

serializedName

serializedName: string = "ActiveSecondary"

type

type: object

className

className: string = "SecondaryActiveReplicatorStatus"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ReplicatorStatus.type.polymorphicDiscriminator

uberParent

uberParent: string = "ReplicatorStatus"

modelProperties

modelProperties: object

Const SecondaryIdleReplicatorStatus

SecondaryIdleReplicatorStatus: object

Status of the secondary replicator when it is in idle mode and is being built by the primary.

Optional copyQueueStatus

copyQueueStatus: ReplicatorQueueStatus

Details about the copy queue on the secondary replicator.

Optional isInBuild

isInBuild: undefined | false | true

Value that indicates whether the replica is currently being built.

kind

kind: "IdleSecondary"

Polymorphic Discriminator

Optional lastAcknowledgementSentTimeUtc

lastAcknowledgementSentTimeUtc: Date

The last time-stamp (UTC) at which an acknowledgment was sent to the primary replicator. UTC 0 represents an invalid value, indicating that an acknowledgment message was never sent.

Optional lastCopyOperationReceivedTimeUtc

lastCopyOperationReceivedTimeUtc: Date

The last time-stamp (UTC) at which a copy operation was received from the primary. UTC 0 represents an invalid value, indicating that a copy operation message was never received.

Optional lastReplicationOperationReceivedTimeUtc

lastReplicationOperationReceivedTimeUtc: Date

The last time-stamp (UTC) at which a replication operation was received from the primary. UTC 0 represents an invalid value, indicating that a replication operation message was never received.

Optional replicationQueueStatus

replicationQueueStatus: ReplicatorQueueStatus

Details about the replication queue on the secondary replicator.

serializedName

serializedName: string = "IdleSecondary"

type

type: object

className

className: string = "SecondaryIdleReplicatorStatus"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ReplicatorStatus.type.polymorphicDiscriminator

uberParent

uberParent: string = "ReplicatorStatus"

modelProperties

modelProperties: object

Const SecondaryReplicatorStatus

SecondaryReplicatorStatus: object

Provides statistics about the Service Fabric Replicator, when it is functioning in a ActiveSecondary role.

Optional copyQueueStatus

copyQueueStatus: ReplicatorQueueStatus

Details about the copy queue on the secondary replicator.

Optional isInBuild

isInBuild: undefined | false | true

Value that indicates whether the replica is currently being built.

kind

kind: "SecondaryReplicatorStatus"

Polymorphic Discriminator

Optional lastAcknowledgementSentTimeUtc

lastAcknowledgementSentTimeUtc: Date

The last time-stamp (UTC) at which an acknowledgment was sent to the primary replicator. UTC 0 represents an invalid value, indicating that an acknowledgment message was never sent.

Optional lastCopyOperationReceivedTimeUtc

lastCopyOperationReceivedTimeUtc: Date

The last time-stamp (UTC) at which a copy operation was received from the primary. UTC 0 represents an invalid value, indicating that a copy operation message was never received.

Optional lastReplicationOperationReceivedTimeUtc

lastReplicationOperationReceivedTimeUtc: Date

The last time-stamp (UTC) at which a replication operation was received from the primary. UTC 0 represents an invalid value, indicating that a replication operation message was never received.

Optional replicationQueueStatus

replicationQueueStatus: ReplicatorQueueStatus

Details about the replication queue on the secondary replicator.

serializedName

serializedName: string = "SecondaryReplicatorStatus"

type

type: object

className

className: string = "SecondaryReplicatorStatus"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ReplicatorStatus.type.polymorphicDiscriminator

uberParent

uberParent: string = "ReplicatorStatus"

modelProperties

modelProperties: object

copyQueueStatus

copyQueueStatus: object

serializedName

serializedName: string = "CopyQueueStatus"

type

type: object

className

className: string = "ReplicatorQueueStatus"

name

name: "Composite" = "Composite"

isInBuild

isInBuild: object

serializedName

serializedName: string = "IsInBuild"

type

type: object

name

name: "Boolean" = "Boolean"

lastAcknowledgementSentTimeUtc

lastAcknowledgementSentTimeUtc: object

serializedName

serializedName: string = "LastAcknowledgementSentTimeUtc"

type

type: object

name

name: "DateTime" = "DateTime"

lastCopyOperationReceivedTimeUtc

lastCopyOperationReceivedTimeUtc: object

serializedName

serializedName: string = "LastCopyOperationReceivedTimeUtc"

type

type: object

name

name: "DateTime" = "DateTime"

lastReplicationOperationReceivedTimeUtc

lastReplicationOperationReceivedTimeUtc: object

serializedName

serializedName: string = "LastReplicationOperationReceivedTimeUtc"

type

type: object

name

name: "DateTime" = "DateTime"

replicationQueueStatus

replicationQueueStatus: object

serializedName

serializedName: string = "ReplicationQueueStatus"

type

type: object

className

className: string = "ReplicatorQueueStatus"

name

name: "Composite" = "Composite"

Const SecretResourceDescription

SecretResourceDescription: object

This type describes a secret resource.

name

name: string

Name of the Secret resource.

properties

Describes the properties of a secret resource.

serializedName

serializedName: string = "SecretResourceDescription"

type

type: object

className

className: string = "SecretResourceDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

properties

properties: object

required

required: true = true

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "SecretResourceProperties"

name

name: "Composite" = "Composite"

Const SecretResourceProperties

SecretResourceProperties: object

Describes the properties of a secret resource.

Optional contentType

contentType: undefined | string

The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed.

Optional description

description: undefined | string

User readable description of the secret.

kind

kind: "SecretResourceProperties"

Polymorphic Discriminator

Optional status

Status of the resource. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional statusDetails

statusDetails: undefined | string

Gives additional information about the current status of the secret. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SecretResourceProperties"

type

type: object

className

className: string = "SecretResourceProperties"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = SecretResourcePropertiesBase.type.polymorphicDiscriminator

uberParent

uberParent: string = "SecretResourcePropertiesBase"

modelProperties

modelProperties: object

contentType

contentType: object

serializedName

serializedName: string = "contentType"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

statusDetails

statusDetails: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "statusDetails"

type

type: object

name

name: "String" = "String"

Const SecretResourcePropertiesBase

SecretResourcePropertiesBase: object

This type describes the properties of a secret resource, including its kind.

kind

kind: "SecretResourcePropertiesBase"

Polymorphic Discriminator

serializedName

serializedName: string = "SecretResourcePropertiesBase"

type

type: object

className

className: string = "SecretResourcePropertiesBase"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "SecretResourcePropertiesBase"

modelProperties

modelProperties: object

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "kind"

Const SecretValue

SecretValue: object

This type represents the unencrypted value of the secret.

Optional value

value: undefined | string

The actual value of the secret.

serializedName

serializedName: string = "SecretValue"

type

type: object

className

className: string = "SecretValue"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const SecretValueProperties

SecretValueProperties: object

This type describes properties of secret value resource.

Optional value

value: undefined | string

The actual value of the secret.

serializedName

serializedName: string = "SecretValueProperties"

type

type: object

className

className: string = "SecretValueProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const SecretValueResourceDescription

SecretValueResourceDescription: object

This type describes a value of a secret resource. The name of this resource is the version identifier corresponding to this secret value.

name

name: string

Version identifier of the secret value.

Optional value

value: undefined | string

The actual value of the secret.

serializedName

serializedName: string = "SecretValueResourceDescription"

type

type: object

className

className: string = "SecretValueResourceDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "properties.value"

type

type: object

name

name: "String" = "String"

Const SeedNodeSafetyCheck

SeedNodeSafetyCheck: object

Represents a safety check for the seed nodes being performed by service fabric before continuing with node level operations.

kind

kind: "EnsureSeedNodeQuorum"

Polymorphic Discriminator

serializedName

serializedName: string = "EnsureSeedNodeQuorum"

type

type: object

className

className: string = "SeedNodeSafetyCheck"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = SafetyCheck.type.polymorphicDiscriminator

uberParent

uberParent: string = "SafetyCheck"

modelProperties

modelProperties: object

Const SelectedPartition

SelectedPartition: object

This class returns information about the partition that the user-induced operation acted upon.

Optional partitionId

partitionId: undefined | string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

Optional serviceName

serviceName: undefined | string

The name of the service the partition belongs to.

serializedName

serializedName: string = "SelectedPartition"

type

type: object

className

className: string = "SelectedPartition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

partitionId

partitionId: object

serializedName

serializedName: string = "PartitionId"

type

type: object

name

name: "Uuid" = "Uuid"

serviceName

serviceName: object

serializedName

serializedName: string = "ServiceName"

type

type: object

name

name: "String" = "String"

Const ServiceBackupConfigurationInfo

ServiceBackupConfigurationInfo: object

Backup configuration information for a specific Service Fabric service specifying what backup policy is being applied and suspend description, if any.

kind

kind: "Service"

Polymorphic Discriminator

Optional policyInheritedFrom

policyInheritedFrom: BackupPolicyScope

Specifies the scope at which the backup policy is applied. Possible values include: 'Invalid', 'Partition', 'Service', 'Application'

Optional policyName

policyName: undefined | string

The name of the backup policy which is applicable to this Service Fabric application or service or partition.

Optional serviceName

serviceName: undefined | string

The full name of the service with 'fabric:' URI scheme.

Optional suspensionInfo

suspensionInfo: BackupSuspensionInfo

Describes the backup suspension details.

serializedName

serializedName: string = "Service"

type

type: object

className

className: string = "ServiceBackupConfigurationInfo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = BackupConfigurationInfo.type.polymorphicDiscriminator

uberParent

uberParent: string = "BackupConfigurationInfo"

modelProperties

modelProperties: object

serviceName

serviceName: object

serializedName

serializedName: string = "ServiceName"

type

type: object

name

name: "String" = "String"

Const ServiceBackupEntity

ServiceBackupEntity: object

Identifies the Service Fabric stateful service which is being backed up.

entityKind

entityKind: "Service"

Polymorphic Discriminator

Optional serviceName

serviceName: undefined | string

The full name of the service with 'fabric:' URI scheme.

serializedName

serializedName: string = "Service"

type

type: object

className

className: string = "ServiceBackupEntity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = BackupEntity.type.polymorphicDiscriminator

uberParent

uberParent: string = "BackupEntity"

modelProperties

modelProperties: object

serviceName

serviceName: object

serializedName

serializedName: string = "ServiceName"

type

type: object

name

name: "String" = "String"

Const ServiceCorrelationDescription

ServiceCorrelationDescription: object

Creates a particular correlation between services.

scheme

The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName. Possible values include: 'Invalid', 'Affinity', 'AlignedAffinity', 'NonAlignedAffinity'

serviceName

serviceName: string

The name of the service that the correlation relationship is established with.

serializedName

serializedName: string = "ServiceCorrelationDescription"

type

type: object

className

className: string = "ServiceCorrelationDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

scheme

scheme: object

required

required: true = true

serializedName

serializedName: string = "Scheme"

type

type: object

name

name: "String" = "String"

serviceName

serviceName: object

required

required: true = true

serializedName

serializedName: string = "ServiceName"

type

type: object

name

name: "String" = "String"

Const ServiceCreatedEvent

ServiceCreatedEvent: object

Service Created event.

applicationName

applicationName: string

Application name.

applicationTypeName

applicationTypeName: string

Application type name.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

isStateful

isStateful: boolean

Indicates if Service is stateful.

kind

kind: "ServiceCreated"

Polymorphic Discriminator

minReplicaSetSize

minReplicaSetSize: number

Minimum size of replicas set.

partitionCount

partitionCount: number

Number of partitions.

partitionId

partitionId: string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

serviceId

serviceId: string

The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.

serviceInstance

serviceInstance: number

Id of Service instance.

servicePackageVersion

servicePackageVersion: string

Version of Service package.

serviceTypeName

serviceTypeName: string

Service type name.

targetReplicaSetSize

targetReplicaSetSize: number

Size of target replicas set.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ServiceCreated"

type

type: object

className

className: string = "ServiceCreatedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

applicationName

applicationName: object

required

required: true = true

serializedName

serializedName: string = "ApplicationName"

type

type: object

name

name: "String" = "String"

applicationTypeName

applicationTypeName: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeName"

type

type: object

name

name: "String" = "String"

isStateful

isStateful: object

required

required: true = true

serializedName

serializedName: string = "IsStateful"

type

type: object

name

name: "Boolean" = "Boolean"

minReplicaSetSize

minReplicaSetSize: object

required

required: true = true

serializedName

serializedName: string = "MinReplicaSetSize"

type

type: object

name

name: "Number" = "Number"

partitionCount

partitionCount: object

required

required: true = true

serializedName

serializedName: string = "PartitionCount"

type

type: object

name

name: "Number" = "Number"

partitionId

partitionId: object

required

required: true = true

serializedName

serializedName: string = "PartitionId"

type

type: object

name

name: "Uuid" = "Uuid"

serviceInstance

serviceInstance: object

required

required: true = true

serializedName

serializedName: string = "ServiceInstance"

type

type: object

name

name: "Number" = "Number"

servicePackageVersion

servicePackageVersion: object

required

required: true = true

serializedName

serializedName: string = "ServicePackageVersion"

type

type: object

name

name: "String" = "String"

serviceTypeName

serviceTypeName: object

required

required: true = true

serializedName

serializedName: string = "ServiceTypeName"

type

type: object

name

name: "String" = "String"

targetReplicaSetSize

targetReplicaSetSize: object

required

required: true = true

serializedName

serializedName: string = "TargetReplicaSetSize"

type

type: object

name

name: "Number" = "Number"

Const ServiceDeletedEvent

ServiceDeletedEvent: object

Service Deleted event.

applicationName

applicationName: string

Application name.

applicationTypeName

applicationTypeName: string

Application type name.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

isStateful

isStateful: boolean

Indicates if Service is stateful.

kind

kind: "ServiceDeleted"

Polymorphic Discriminator

minReplicaSetSize

minReplicaSetSize: number

Minimum size of replicas set.

partitionCount

partitionCount: number

Number of partitions.

serviceId

serviceId: string

The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.

serviceInstance

serviceInstance: number

Id of Service instance.

servicePackageVersion

servicePackageVersion: string

Version of Service package.

serviceTypeName

serviceTypeName: string

Service type name.

targetReplicaSetSize

targetReplicaSetSize: number

Size of target replicas set.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ServiceDeleted"

type

type: object

className

className: string = "ServiceDeletedEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

applicationName

applicationName: object

required

required: true = true

serializedName

serializedName: string = "ApplicationName"

type

type: object

name

name: "String" = "String"

applicationTypeName

applicationTypeName: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeName"

type

type: object

name

name: "String" = "String"

isStateful

isStateful: object

required

required: true = true

serializedName

serializedName: string = "IsStateful"

type

type: object

name

name: "Boolean" = "Boolean"

minReplicaSetSize

minReplicaSetSize: object

required

required: true = true

serializedName

serializedName: string = "MinReplicaSetSize"

type

type: object

name

name: "Number" = "Number"

partitionCount

partitionCount: object

required

required: true = true

serializedName

serializedName: string = "PartitionCount"

type

type: object

name

name: "Number" = "Number"

serviceInstance

serviceInstance: object

required

required: true = true

serializedName

serializedName: string = "ServiceInstance"

type

type: object

name

name: "Number" = "Number"

servicePackageVersion

servicePackageVersion: object

required

required: true = true

serializedName

serializedName: string = "ServicePackageVersion"

type

type: object

name

name: "String" = "String"

serviceTypeName

serviceTypeName: object

required

required: true = true

serializedName

serializedName: string = "ServiceTypeName"

type

type: object

name

name: "String" = "String"

targetReplicaSetSize

targetReplicaSetSize: object

required

required: true = true

serializedName

serializedName: string = "TargetReplicaSetSize"

type

type: object

name

name: "Number" = "Number"

Const ServiceDescription

ServiceDescription: object

A ServiceDescription contains all of the information necessary to create a service.

Optional applicationName

applicationName: undefined | string

The name of the application, including the 'fabric:' URI scheme.

Optional correlationScheme

correlationScheme: ServiceCorrelationDescription[]

The correlation scheme.

Optional defaultMoveCost

defaultMoveCost: MoveCost

The move cost for the service. Possible values include: 'Zero', 'Low', 'Medium', 'High'

Optional initializationData

initializationData: number[]

The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created.

Optional isDefaultMoveCostSpecified

isDefaultMoveCostSpecified: undefined | false | true

Indicates if the DefaultMoveCost property is specified.

partitionDescription

partitionDescription: PartitionSchemeDescriptionUnion

The partition description as an object.

Optional placementConstraints

placementConstraints: undefined | string

The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".

Optional scalingPolicies

scalingPolicies: ScalingPolicyDescription[]

Scaling policies for this service.

Optional serviceDnsName

serviceDnsName: undefined | string

The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster.

serviceKind

serviceKind: "ServiceDescription"

Polymorphic Discriminator

Optional serviceLoadMetrics

serviceLoadMetrics: ServiceLoadMetricDescription[]

The service load metrics.

serviceName

serviceName: string

The full name of the service with 'fabric:' URI scheme.

Optional servicePackageActivationMode

servicePackageActivationMode: ServicePackageActivationMode

The activation mode of service package to be used for a service. Possible values include: 'SharedProcess', 'ExclusiveProcess'

Optional servicePlacementPolicies

servicePlacementPolicies: ServicePlacementPolicyDescriptionUnion[]

The service placement policies.

serviceTypeName

serviceTypeName: string

Name of the service type as specified in the service manifest.

serializedName

serializedName: string = "ServiceDescription"

type

type: object

className

className: string = "ServiceDescription"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ServiceDescription"

modelProperties

modelProperties: object

applicationName

applicationName: object

serializedName

serializedName: string = "ApplicationName"

type

type: object

name

name: "String" = "String"

correlationScheme

correlationScheme: object

serializedName

serializedName: string = "CorrelationScheme"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceCorrelationDescription"

name

name: "Composite" = "Composite"

defaultMoveCost

defaultMoveCost: object

serializedName

serializedName: string = "DefaultMoveCost"

type

type: object

name

name: "String" = "String"

initializationData

initializationData: object

serializedName

serializedName: string = "InitializationData"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Number" = "Number"

isDefaultMoveCostSpecified

isDefaultMoveCostSpecified: object

serializedName

serializedName: string = "IsDefaultMoveCostSpecified"

type

type: object

name

name: "Boolean" = "Boolean"

partitionDescription

partitionDescription: object

required

required: true = true

serializedName

serializedName: string = "PartitionDescription"

type

type: object

className

className: string = "PartitionSchemeDescription"

name

name: "Composite" = "Composite"

placementConstraints

placementConstraints: object

serializedName

serializedName: string = "PlacementConstraints"

type

type: object

name

name: "String" = "String"

scalingPolicies

scalingPolicies: object

serializedName

serializedName: string = "ScalingPolicies"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ScalingPolicyDescription"

name

name: "Composite" = "Composite"

serviceDnsName

serviceDnsName: object

serializedName

serializedName: string = "ServiceDnsName"

type

type: object

name

name: "String" = "String"

serviceKind

serviceKind: object

required

required: true = true

serializedName

serializedName: string = "ServiceKind"

type

type: object

name

name: "String" = "String"

serviceLoadMetrics

serviceLoadMetrics: object

serializedName

serializedName: string = "ServiceLoadMetrics"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceLoadMetricDescription"

name

name: "Composite" = "Composite"

serviceName

serviceName: object

required

required: true = true

serializedName

serializedName: string = "ServiceName"

type

type: object

name

name: "String" = "String"

servicePackageActivationMode

servicePackageActivationMode: object

serializedName

serializedName: string = "ServicePackageActivationMode"

type

type: object

name

name: "String" = "String"

servicePlacementPolicies

servicePlacementPolicies: object

serializedName

serializedName: string = "ServicePlacementPolicies"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServicePlacementPolicyDescription"

name

name: "Composite" = "Composite"

serviceTypeName

serviceTypeName: object

required

required: true = true

serializedName

serializedName: string = "ServiceTypeName"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "serviceKind"

serializedName

serializedName: string = "ServiceKind"

Const ServiceEvent

ServiceEvent: object

Represents the base for all Service Events.

Optional category

category: undefined | string

The category of event.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

kind

kind: "ServiceEvent"

Polymorphic Discriminator

serviceId

serviceId: string

The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.

timeStamp

timeStamp: Date

The time event was logged.

serializedName

serializedName: string = "ServiceEvent"

type

type: object

className

className: string = "ServiceEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

serviceId

serviceId: object

required

required: true = true

serializedName

serializedName: string = "ServiceId"

type

type: object

name

name: "String" = "String"

Const ServiceFromTemplateDescription

ServiceFromTemplateDescription: object

Defines description for creating a Service Fabric service from a template defined in the application manifest.

applicationName

applicationName: string

The name of the application, including the 'fabric:' URI scheme.

Optional initializationData

initializationData: number[]

The initialization data for the newly created service instance.

Optional serviceDnsName

serviceDnsName: undefined | string

The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster.

serviceName

serviceName: string

The full name of the service with 'fabric:' URI scheme.

Optional servicePackageActivationMode

servicePackageActivationMode: ServicePackageActivationMode

The activation mode of service package to be used for a service. Possible values include: 'SharedProcess', 'ExclusiveProcess'

serviceTypeName

serviceTypeName: string

Name of the service type as specified in the service manifest.

serializedName

serializedName: string = "ServiceFromTemplateDescription"

type

type: object

className

className: string = "ServiceFromTemplateDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationName

applicationName: object

required

required: true = true

serializedName

serializedName: string = "ApplicationName"

type

type: object

name

name: "String" = "String"

initializationData

initializationData: object

serializedName

serializedName: string = "InitializationData"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Number" = "Number"

serviceDnsName

serviceDnsName: object

serializedName

serializedName: string = "ServiceDnsName"

type

type: object

name

name: "String" = "String"

serviceName

serviceName: object

required

required: true = true

serializedName

serializedName: string = "ServiceName"

type

type: object

name

name: "String" = "String"

servicePackageActivationMode

servicePackageActivationMode: object

serializedName

serializedName: string = "ServicePackageActivationMode"

type

type: object

name

name: "String" = "String"

serviceTypeName

serviceTypeName: object

required

required: true = true

serializedName

serializedName: string = "ServiceTypeName"

type

type: object

name

name: "String" = "String"

Const ServiceHealth

ServiceHealth: object

Information about the health of a Service Fabric service.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional healthEvents

healthEvents: HealthEvent[]

The list of health events reported on the entity.

Optional healthStatistics

healthStatistics: HealthStatistics

Shows the health statistics for all children types of the queried entity.

Optional name

name: undefined | string

The name of the service whose health information is described by this object.

Optional partitionHealthStates

partitionHealthStates: PartitionHealthState[]

The list of partition health states associated with the service.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.

serializedName

serializedName: string = "ServiceHealth"

type

type: object

className

className: string = "ServiceHealth"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

partitionHealthStates

partitionHealthStates: object

serializedName

serializedName: string = "PartitionHealthStates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PartitionHealthState"

name

name: "Composite" = "Composite"

Const ServiceHealthEvaluation

ServiceHealthEvaluation: object

Represents health evaluation for a service, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional description

description: undefined | string

Description of the health evaluation, which represents a summary of the evaluation process.

kind

kind: "Service"

Polymorphic Discriminator

Optional serviceName

serviceName: undefined | string

Name of the service whose health evaluation is described by this object.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

List of unhealthy evaluations that led to the current aggregated health state of the service. The types of the unhealthy evaluations can be PartitionsHealthEvaluation or EventHealthEvaluation.

serializedName

serializedName: string = "Service"

type

type: object

className

className: string = "ServiceHealthEvaluation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = HealthEvaluation.type.polymorphicDiscriminator

uberParent

uberParent: string = "HealthEvaluation"

modelProperties

modelProperties: object

serviceName

serviceName: object

serializedName

serializedName: string = "ServiceName"

type

type: object

name

name: "String" = "String"

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

Const ServiceHealthReportExpiredEvent

ServiceHealthReportExpiredEvent: object

Service Health Report Expired event.

Optional category

category: undefined | string

The category of event.

description

description: string

Description of report.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

healthState

healthState: string

Describes the property health state.

instanceId

instanceId: number

Id of Service instance.

kind

kind: "ServiceHealthReportExpired"

Polymorphic Discriminator

property

property: string

Describes the property.

removeWhenExpired

removeWhenExpired: boolean

Indicates the removal when it expires.

sequenceNumber

sequenceNumber: number

Sequence number of report.

serviceId

serviceId: string

The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.

sourceId

sourceId: string

Id of report source.

sourceUtcTimestamp

sourceUtcTimestamp: Date

Source time.

timeStamp

timeStamp: Date

The time event was logged.

timeToLiveMs

timeToLiveMs: number

Time to live in milli-seconds.

serializedName

serializedName: string = "ServiceHealthReportExpired"

type

type: object

className

className: string = "ServiceHealthReportExpiredEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

description

description: object

required

required: true = true

serializedName

serializedName: string = "Description"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

required

required: true = true

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

instanceId

instanceId: object

required

required: true = true

serializedName

serializedName: string = "InstanceId"

type

type: object

name

name: "Number" = "Number"

property

property: object

required

required: true = true

serializedName

serializedName: string = "Property"

type

type: object

name

name: "String" = "String"

removeWhenExpired

removeWhenExpired: object

required

required: true = true

serializedName

serializedName: string = "RemoveWhenExpired"

type

type: object

name

name: "Boolean" = "Boolean"

sequenceNumber

sequenceNumber: object

required

required: true = true

serializedName

serializedName: string = "SequenceNumber"

type

type: object

name

name: "Number" = "Number"

sourceId

sourceId: object

required

required: true = true

serializedName

serializedName: string = "SourceId"

type

type: object

name

name: "String" = "String"

sourceUtcTimestamp

sourceUtcTimestamp: object

required

required: true = true

serializedName

serializedName: string = "SourceUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

timeToLiveMs

timeToLiveMs: object

required

required: true = true

serializedName

serializedName: string = "TimeToLiveMs"

type

type: object

name

name: "Number" = "Number"

Const ServiceHealthState

ServiceHealthState: object

Represents the health state of a service, which contains the service identifier and its aggregated health state.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional serviceName

serviceName: undefined | string

Name of the service whose health state is represented by this object.

serializedName

serializedName: string = "ServiceHealthState"

type

type: object

className

className: string = "ServiceHealthState"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

serviceName

serviceName: object

serializedName

serializedName: string = "ServiceName"

type

type: object

name

name: "String" = "String"

Const ServiceHealthStateChunk

ServiceHealthStateChunk: object

Represents the health state chunk of a service, which contains the service name, its aggregated health state and any partitions that respect the filters in the cluster health chunk query description.

Optional healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional partitionHealthStateChunks

partitionHealthStateChunks: PartitionHealthStateChunkList

The list of partition health state chunks belonging to the service that respect the filters in the cluster health chunk query description.

Optional serviceName

serviceName: undefined | string

The name of the service whose health state chunk is provided in this object.

serializedName

serializedName: string = "ServiceHealthStateChunk"

type

type: object

className

className: string = "ServiceHealthStateChunk"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

partitionHealthStateChunks

partitionHealthStateChunks: object

serializedName

serializedName: string = "PartitionHealthStateChunks"

type

type: object

className

className: string = "PartitionHealthStateChunkList"

name

name: "Composite" = "Composite"

serviceName

serviceName: object

serializedName

serializedName: string = "ServiceName"

type

type: object

name

name: "String" = "String"

Const ServiceHealthStateChunkList

ServiceHealthStateChunkList: object

The list of service health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.

Optional items

The list of service health state chunks that respect the input filters in the chunk query.

serializedName

serializedName: string = "ServiceHealthStateChunkList"

type

type: object

className

className: string = "ServiceHealthStateChunkList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

items

items: object

serializedName

serializedName: string = "Items"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceHealthStateChunk"

name

name: "Composite" = "Composite"

Const ServiceHealthStateFilter

ServiceHealthStateFilter: object

Defines matching criteria to determine whether a service should be included as a child of an application in the cluster health chunk. The services are only returned if the parent application matches a filter specified in the cluster health chunk query description. One filter can match zero, one or multiple services, depending on its properties.

Optional healthStateFilter

healthStateFilter: undefined | number

The filter for the health state of the services. It allows selecting services if they match the desired health states. The possible values are integer value of one of the following health states. Only services that match the filter are returned. All services are used to evaluate the cluster aggregated health state. If not specified, default value is None, unless the service name is specified. If the filter has default value and service name is specified, the matching service is returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6, it matches services with HealthState value of OK (2) and Warning (4).

  • Default - Default value. Matches any HealthState. The value is zero.
  • None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.
  • Ok - Filter that matches input with HealthState value Ok. The value is 2.
  • Warning - Filter that matches input with HealthState value Warning. The value is 4.
  • Error - Filter that matches input with HealthState value Error. The value is 8.
  • All - Filter that matches input with any HealthState value. The value is 65535. Default value: 0.

Optional partitionFilters

partitionFilters: PartitionHealthStateFilter[]

Defines a list of filters that specify which partitions to be included in the returned cluster health chunk as children of the service. The partitions are returned only if the parent service matches a filter. If the list is empty, no partitions are returned. All the partitions are used to evaluate the parent service aggregated health state, regardless of the input filters. The service filter may specify multiple partition filters. For example, it can specify a filter to return all partitions with health state Error and another filter to always include a partition identified by its partition ID.

Optional serviceNameFilter

serviceNameFilter: undefined | string

The name of the service that matches the filter. The filter is applied only to the specified service, if it exists. If the service doesn't exist, no service is returned in the cluster health chunk based on this filter. If the service exists, it is included as the application's child if the health state matches the other filter properties. If not specified, all services that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.

serializedName

serializedName: string = "ServiceHealthStateFilter"

type

type: object

className

className: string = "ServiceHealthStateFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

healthStateFilter

healthStateFilter: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "HealthStateFilter"

type

type: object

name

name: "Number" = "Number"

partitionFilters

partitionFilters: object

serializedName

serializedName: string = "PartitionFilters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PartitionHealthStateFilter"

name

name: "Composite" = "Composite"

serviceNameFilter

serviceNameFilter: object

serializedName

serializedName: string = "ServiceNameFilter"

type

type: object

name

name: "String" = "String"

Const ServiceIdentity

ServiceIdentity: object

Map service identity friendly name to an application identity.

Optional identityRef

identityRef: undefined | string

The application identity name.

Optional name

name: undefined | string

The identity friendly name.

serializedName

serializedName: string = "ServiceIdentity"

type

type: object

className

className: string = "ServiceIdentity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

identityRef

identityRef: object

serializedName

serializedName: string = "identityRef"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const ServiceInfo

ServiceInfo: object

Information about a Service Fabric service.

Optional healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional id

id: undefined | string

The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.

Optional isServiceGroup

isServiceGroup: undefined | false | true

Whether the service is in a service group.

Optional manifestVersion

manifestVersion: undefined | string

The version of the service manifest.

Optional name

name: undefined | string

The full name of the service with 'fabric:' URI scheme.

serviceKind

serviceKind: "ServiceInfo"

Polymorphic Discriminator

Optional serviceStatus

serviceStatus: ServiceStatus

The status of the application. Possible values include: 'Unknown', 'Active', 'Upgrading', 'Deleting', 'Creating', 'Failed'

Optional typeName

typeName: undefined | string

Name of the service type as specified in the service manifest.

serializedName

serializedName: string = "ServiceInfo"

type

type: object

className

className: string = "ServiceInfo"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ServiceInfo"

modelProperties

modelProperties: object

healthState

healthState: object

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

id

id: object

serializedName

serializedName: string = "Id"

type

type: object

name

name: "String" = "String"

isServiceGroup

isServiceGroup: object

serializedName

serializedName: string = "IsServiceGroup"

type

type: object

name

name: "Boolean" = "Boolean"

manifestVersion

manifestVersion: object

serializedName

serializedName: string = "ManifestVersion"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

serviceKind

serviceKind: object

required

required: true = true

serializedName

serializedName: string = "ServiceKind"

type

type: object

name

name: "String" = "String"

serviceStatus

serviceStatus: object

serializedName

serializedName: string = "ServiceStatus"

type

type: object

name

name: "String" = "String"

typeName

typeName: object

serializedName

serializedName: string = "TypeName"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "serviceKind"

serializedName

serializedName: string = "ServiceKind"

Const ServiceLoadMetricDescription

ServiceLoadMetricDescription: object

Specifies a metric to load balance a service during runtime.

Optional defaultLoad

defaultLoad: undefined | number

Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric.

name

name: string

The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case-sensitive.

Optional primaryDefaultLoad

primaryDefaultLoad: undefined | number

Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica.

Optional secondaryDefaultLoad

secondaryDefaultLoad: undefined | number

Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica.

Optional weight

The service load metric relative weight, compared to other metrics configured for this service, as a number. Possible values include: 'Zero', 'Low', 'Medium', 'High'

serializedName

serializedName: string = "ServiceLoadMetricDescription"

type

type: object

className

className: string = "ServiceLoadMetricDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

defaultLoad

defaultLoad: object

serializedName

serializedName: string = "DefaultLoad"

type

type: object

name

name: "Number" = "Number"

name

name: object

required

required: true = true

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

primaryDefaultLoad

primaryDefaultLoad: object

serializedName

serializedName: string = "PrimaryDefaultLoad"

type

type: object

name

name: "Number" = "Number"

secondaryDefaultLoad

secondaryDefaultLoad: object

serializedName

serializedName: string = "SecondaryDefaultLoad"

type

type: object

name

name: "Number" = "Number"

weight

weight: object

serializedName

serializedName: string = "Weight"

type

type: object

name

name: "String" = "String"

Const ServiceNameInfo

ServiceNameInfo: object

Information about the service name.

Optional id

id: undefined | string

The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.

Optional name

name: undefined | string

The full name of the service with 'fabric:' URI scheme.

serializedName

serializedName: string = "ServiceNameInfo"

type

type: object

className

className: string = "ServiceNameInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "Id"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

Const ServiceNewHealthReportEvent

ServiceNewHealthReportEvent: object

Service Health Report Created event.

Optional category

category: undefined | string

The category of event.

description

description: string

Description of report.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

healthState

healthState: string

Describes the property health state.

instanceId

instanceId: number

Id of Service instance.

kind

kind: "ServiceNewHealthReport"

Polymorphic Discriminator

property

property: string

Describes the property.

removeWhenExpired

removeWhenExpired: boolean

Indicates the removal when it expires.

sequenceNumber

sequenceNumber: number

Sequence number of report.

serviceId

serviceId: string

The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.

sourceId

sourceId: string

Id of report source.

sourceUtcTimestamp

sourceUtcTimestamp: Date

Source time.

timeStamp

timeStamp: Date

The time event was logged.

timeToLiveMs

timeToLiveMs: number

Time to live in milli-seconds.

serializedName

serializedName: string = "ServiceNewHealthReport"

type

type: object

className

className: string = "ServiceNewHealthReportEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

description

description: object

required

required: true = true

serializedName

serializedName: string = "Description"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

required

required: true = true

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

instanceId

instanceId: object

required

required: true = true

serializedName

serializedName: string = "InstanceId"

type

type: object

name

name: "Number" = "Number"

property

property: object

required

required: true = true

serializedName

serializedName: string = "Property"

type

type: object

name

name: "String" = "String"

removeWhenExpired

removeWhenExpired: object

required

required: true = true

serializedName

serializedName: string = "RemoveWhenExpired"

type

type: object

name

name: "Boolean" = "Boolean"

sequenceNumber

sequenceNumber: object

required

required: true = true

serializedName

serializedName: string = "SequenceNumber"

type

type: object

name

name: "Number" = "Number"

sourceId

sourceId: object

required

required: true = true

serializedName

serializedName: string = "SourceId"

type

type: object

name

name: "String" = "String"

sourceUtcTimestamp

sourceUtcTimestamp: object

required

required: true = true

serializedName

serializedName: string = "SourceUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

timeToLiveMs

timeToLiveMs: object

required

required: true = true

serializedName

serializedName: string = "TimeToLiveMs"

type

type: object

name

name: "Number" = "Number"

Const ServicePartitionInfo

ServicePartitionInfo: object

Information about a partition of a Service Fabric service.

Optional healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional partitionInformation

partitionInformation: PartitionInformationUnion

Information about the partition identity, partitioning scheme and keys supported by it.

Optional partitionStatus

partitionStatus: ServicePartitionStatus

The status of the service fabric service partition. Possible values include: 'Invalid', 'Ready', 'NotReady', 'InQuorumLoss', 'Reconfiguring', 'Deleting'

serviceKind

serviceKind: "ServicePartitionInfo"

Polymorphic Discriminator

serializedName

serializedName: string = "ServicePartitionInfo"

type

type: object

className

className: string = "ServicePartitionInfo"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ServicePartitionInfo"

modelProperties

modelProperties: object

healthState

healthState: object

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

partitionInformation

partitionInformation: object

serializedName

serializedName: string = "PartitionInformation"

type

type: object

className

className: string = "PartitionInformation"

name

name: "Composite" = "Composite"

partitionStatus

partitionStatus: object

serializedName

serializedName: string = "PartitionStatus"

type

type: object

name

name: "String" = "String"

serviceKind

serviceKind: object

required

required: true = true

serializedName

serializedName: string = "ServiceKind"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "serviceKind"

serializedName

serializedName: string = "ServiceKind"

Const ServicePlacementInvalidDomainPolicyDescription

ServicePlacementInvalidDomainPolicyDescription: object

Describes the policy to be used for placement of a Service Fabric service where a particular fault or upgrade domain should not be used for placement of the instances or replicas of that service.

Optional domainName

domainName: undefined | string

The name of the domain that should not be used for placement.

serializedName

serializedName: string = "InvalidDomain"

type

type: object

Polymorphic Discriminator

className

className: string = "ServicePlacementInvalidDomainPolicyDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ServicePlacementPolicyDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "ServicePlacementPolicyDescription"

modelProperties

modelProperties: object

domainName

domainName: object

serializedName

serializedName: string = "DomainName"

type

type: object

name

name: "String" = "String"

Const ServicePlacementNonPartiallyPlaceServicePolicyDescription

ServicePlacementNonPartiallyPlaceServicePolicyDescription: object

Describes the policy to be used for placement of a Service Fabric service where all replicas must be able to be placed in order for any replicas to be created.

serializedName

serializedName: string = "NonPartiallyPlaceService"

type

type: object

Polymorphic Discriminator

className

className: string = "ServicePlacementNonPartiallyPlaceServicePolicyDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ServicePlacementPolicyDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "ServicePlacementPolicyDescription"

modelProperties

modelProperties: object

Const ServicePlacementPolicyDescription

ServicePlacementPolicyDescription: object

Describes the policy to be used for placement of a Service Fabric service.

serializedName

serializedName: string = "ServicePlacementPolicyDescription"

type

type: object

Polymorphic Discriminator

className

className: string = "ServicePlacementPolicyDescription"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ServicePlacementPolicyDescription"

modelProperties

modelProperties: object

type

type: object

required

required: true = true

serializedName

serializedName: string = "Type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "type"

serializedName

serializedName: string = "Type"

Const ServicePlacementPreferPrimaryDomainPolicyDescription

ServicePlacementPreferPrimaryDomainPolicyDescription: object

Describes the policy to be used for placement of a Service Fabric service where the service's Primary replicas should optimally be placed in a particular domain.

This placement policy is usually used with fault domains in scenarios where the Service Fabric cluster is geographically distributed in order to indicate that a service's primary replica should be located in a particular fault domain, which in geo-distributed scenarios usually aligns with regional or datacenter boundaries. Note that since this is an optimization it is possible that the Primary replica may not end up located in this domain due to failures, capacity limits, or other constraints.

Optional domainName

domainName: undefined | string

The name of the domain that should used for placement as per this policy.

serializedName

serializedName: string = "PreferPrimaryDomain"

type

type: object

Polymorphic Discriminator

className

className: string = "ServicePlacementPreferPrimaryDomainPolicyDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ServicePlacementPolicyDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "ServicePlacementPolicyDescription"

modelProperties

modelProperties: object

domainName

domainName: object

serializedName

serializedName: string = "DomainName"

type

type: object

name

name: "String" = "String"

Const ServicePlacementRequireDomainDistributionPolicyDescription

ServicePlacementRequireDomainDistributionPolicyDescription: object

Describes the policy to be used for placement of a Service Fabric service where two replicas from the same partition should never be placed in the same fault or upgrade domain.

While this is not common it can expose the service to an increased risk of concurrent failures due to unplanned outages or other cases of subsequent/concurrent failures. As an example, consider a case where replicas are deployed across different data center, with one replica per location. In the event that one of the datacenters goes offline, normally the replica that was placed in that datacenter will be packed into one of the remaining datacenters. If this is not desirable then this policy should be set.

Optional domainName

domainName: undefined | string

The name of the domain that should used for placement as per this policy.

serializedName

serializedName: string = "RequireDomainDistribution"

type

type: object

Polymorphic Discriminator

className

className: string = "ServicePlacementRequireDomainDistributionPolicyDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ServicePlacementPolicyDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "ServicePlacementPolicyDescription"

modelProperties

modelProperties: object

domainName

domainName: object

serializedName

serializedName: string = "DomainName"

type

type: object

name

name: "String" = "String"

Const ServicePlacementRequiredDomainPolicyDescription

ServicePlacementRequiredDomainPolicyDescription: object

Describes the policy to be used for placement of a Service Fabric service where the instances or replicas of that service must be placed in a particular domain

Optional domainName

domainName: undefined | string

The name of the domain that should used for placement as per this policy.

serializedName

serializedName: string = "RequireDomain"

type

type: object

Polymorphic Discriminator

className

className: string = "ServicePlacementRequiredDomainPolicyDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ServicePlacementPolicyDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "ServicePlacementPolicyDescription"

modelProperties

modelProperties: object

domainName

domainName: object

serializedName

serializedName: string = "DomainName"

type

type: object

name

name: "String" = "String"

Const ServiceProperties

ServiceProperties: object

Describes properties of a service resource.

Optional autoScalingPolicies

autoScalingPolicies: AutoScalingPolicy[]

Auto scaling policies

Optional description

description: undefined | string

User readable description of the service.

Optional healthState

healthState: HealthState

Describes the health state of an application resource. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' NOTE: This property will not be serialized. It can only be populated by the server.

Optional identityRefs

identityRefs: ServiceIdentity[]

The service identity list.

Optional replicaCount

replicaCount: undefined | number

The number of replicas of the service to create. Defaults to 1 if not specified.

Optional status

Status of the service. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional statusDetails

statusDetails: undefined | string

Gives additional information about the current status of the service. NOTE: This property will not be serialized. It can only be populated by the server.

Optional unhealthyEvaluation

unhealthyEvaluation: undefined | string

When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServiceProperties"

type

type: object

className

className: string = "ServiceProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

autoScalingPolicies

autoScalingPolicies: object

serializedName

serializedName: string = "autoScalingPolicies"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AutoScalingPolicy"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "healthState"

type

type: object

name

name: "String" = "String"

identityRefs

identityRefs: object

serializedName

serializedName: string = "identityRefs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceIdentity"

name

name: "Composite" = "Composite"

replicaCount

replicaCount: object

serializedName

serializedName: string = "replicaCount"

type

type: object

name

name: "Number" = "Number"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

statusDetails

statusDetails: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "statusDetails"

type

type: object

name

name: "String" = "String"

unhealthyEvaluation

unhealthyEvaluation: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "unhealthyEvaluation"

type

type: object

name

name: "String" = "String"

Const ServiceReplicaDescription

ServiceReplicaDescription: object

Describes a replica of a service resource.

codePackages

Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.).

Optional diagnostics

diagnostics: DiagnosticsRef

Reference to sinks in DiagnosticsDescription.

Optional networkRefs

networkRefs: NetworkRef[]

The names of the private networks that this service needs to be part of.

osType

The operation system required by the code in service. Possible values include: 'Linux', 'Windows'

replicaName

replicaName: string

Name of the replica.

serializedName

serializedName: string = "ServiceReplicaDescription"

type

type: object

className

className: string = "ServiceReplicaDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

replicaName

replicaName: object

required

required: true = true

serializedName

serializedName: string = "replicaName"

type

type: object

name

name: "String" = "String"

Const ServiceReplicaProperties

ServiceReplicaProperties: object

Describes the properties of a service replica.

codePackages

Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.).

Optional diagnostics

diagnostics: DiagnosticsRef

Reference to sinks in DiagnosticsDescription.

Optional networkRefs

networkRefs: NetworkRef[]

The names of the private networks that this service needs to be part of.

osType

The operation system required by the code in service. Possible values include: 'Linux', 'Windows'

serializedName

serializedName: string = "ServiceReplicaProperties"

type

type: object

className

className: string = "ServiceReplicaProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

codePackages

codePackages: object

required

required: true = true

serializedName

serializedName: string = "codePackages"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ContainerCodePackageProperties"

name

name: "Composite" = "Composite"

diagnostics

diagnostics: object

serializedName

serializedName: string = "diagnostics"

type

type: object

className

className: string = "DiagnosticsRef"

name

name: "Composite" = "Composite"

networkRefs

networkRefs: object

serializedName

serializedName: string = "networkRefs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkRef"

name

name: "Composite" = "Composite"

osType

osType: object

required

required: true = true

serializedName

serializedName: string = "osType"

type

type: object

name

name: "String" = "String"

Const ServiceResourceDescription

ServiceResourceDescription: object

This type describes a service resource.

Optional autoScalingPolicies

autoScalingPolicies: AutoScalingPolicy[]

Auto scaling policies

codePackages

Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.).

Optional description

description: undefined | string

User readable description of the service.

Optional diagnostics

diagnostics: DiagnosticsRef

Reference to sinks in DiagnosticsDescription.

Optional healthState

healthState: HealthState

Describes the health state of an application resource. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' NOTE: This property will not be serialized. It can only be populated by the server.

Optional identityRefs

identityRefs: ServiceIdentity[]

The service identity list.

name

name: string

Name of the Service resource.

Optional networkRefs

networkRefs: NetworkRef[]

The names of the private networks that this service needs to be part of.

osType

The operation system required by the code in service. Possible values include: 'Linux', 'Windows'

Optional replicaCount

replicaCount: undefined | number

The number of replicas of the service to create. Defaults to 1 if not specified.

Optional status

Status of the service. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional statusDetails

statusDetails: undefined | string

Gives additional information about the current status of the service. NOTE: This property will not be serialized. It can only be populated by the server.

Optional unhealthyEvaluation

unhealthyEvaluation: undefined | string

When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServiceResourceDescription"

type

type: object

className

className: string = "ServiceResourceDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

autoScalingPolicies

autoScalingPolicies: object

serializedName

serializedName: string = "properties.autoScalingPolicies"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AutoScalingPolicy"

name

name: "Composite" = "Composite"

codePackages

codePackages: object

required

required: true = true

serializedName

serializedName: string = "properties.codePackages"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ContainerCodePackageProperties"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

diagnostics

diagnostics: object

serializedName

serializedName: string = "properties.diagnostics"

type

type: object

className

className: string = "DiagnosticsRef"

name

name: "Composite" = "Composite"

healthState

healthState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.healthState"

type

type: object

name

name: "String" = "String"

identityRefs

identityRefs: object

serializedName

serializedName: string = "properties.identityRefs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceIdentity"

name

name: "Composite" = "Composite"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

networkRefs

networkRefs: object

serializedName

serializedName: string = "properties.networkRefs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkRef"

name

name: "Composite" = "Composite"

osType

osType: object

required

required: true = true

serializedName

serializedName: string = "properties.osType"

type

type: object

name

name: "String" = "String"

replicaCount

replicaCount: object

serializedName

serializedName: string = "properties.replicaCount"

type

type: object

name

name: "Number" = "Number"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

statusDetails

statusDetails: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.statusDetails"

type

type: object

name

name: "String" = "String"

unhealthyEvaluation

unhealthyEvaluation: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.unhealthyEvaluation"

type

type: object

name

name: "String" = "String"

Const ServiceTypeDescription

ServiceTypeDescription: object

Describes a service type defined in the service manifest of a provisioned application type. The properties the ones defined in the service manifest.

Optional extensions

List of service type extensions.

Optional isStateful

isStateful: undefined | false | true

Indicates whether the service type is a stateful service type or a stateless service type. This property is true if the service type is a stateful service type, false otherwise.

kind

kind: "ServiceTypeDescription"

Polymorphic Discriminator

Optional loadMetrics

The service load metrics is given as an array of ServiceLoadMetricDescription objects.

Optional placementConstraints

placementConstraints: undefined | string

The placement constraint to be used when instantiating this service in a Service Fabric cluster.

Optional servicePlacementPolicies

servicePlacementPolicies: ServicePlacementPolicyDescriptionUnion[]

List of service placement policy descriptions.

Optional serviceTypeName

serviceTypeName: undefined | string

Name of the service type as specified in the service manifest.

serializedName

serializedName: string = "ServiceTypeDescription"

type

type: object

className

className: string = "ServiceTypeDescription"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ServiceTypeDescription"

modelProperties

modelProperties: object

extensions

extensions: object

serializedName

serializedName: string = "Extensions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceTypeExtensionDescription"

name

name: "Composite" = "Composite"

isStateful

isStateful: object

serializedName

serializedName: string = "IsStateful"

type

type: object

name

name: "Boolean" = "Boolean"

kind

kind: object

required

required: true = true

serializedName

serializedName: string = "Kind"

type

type: object

name

name: "String" = "String"

loadMetrics

loadMetrics: object

serializedName

serializedName: string = "LoadMetrics"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceLoadMetricDescription"

name

name: "Composite" = "Composite"

placementConstraints

placementConstraints: object

serializedName

serializedName: string = "PlacementConstraints"

type

type: object

name

name: "String" = "String"

servicePlacementPolicies

servicePlacementPolicies: object

serializedName

serializedName: string = "ServicePlacementPolicies"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServicePlacementPolicyDescription"

name

name: "Composite" = "Composite"

serviceTypeName

serviceTypeName: object

serializedName

serializedName: string = "ServiceTypeName"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "kind"

serializedName

serializedName: string = "Kind"

Const ServiceTypeExtensionDescription

ServiceTypeExtensionDescription: object

Describes extension of a service type defined in the service manifest.

Optional key

key: undefined | string

The name of the extension.

Optional value

value: undefined | string

The extension value.

serializedName

serializedName: string = "ServiceTypeExtensionDescription"

type

type: object

className

className: string = "ServiceTypeExtensionDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

key

key: object

serializedName

serializedName: string = "Key"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "Value"

type

type: object

name

name: "String" = "String"

Const ServiceTypeHealthPolicy

ServiceTypeHealthPolicy: object

Represents the health policy used to evaluate the health of services belonging to a service type.

Optional maxPercentUnhealthyPartitionsPerService

maxPercentUnhealthyPartitionsPerService: undefined | number

The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100

The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero. Default value: 0.

Optional maxPercentUnhealthyReplicasPerPartition

maxPercentUnhealthyReplicasPerPartition: undefined | number

The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100.

The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero. Default value: 0.

Optional maxPercentUnhealthyServices

maxPercentUnhealthyServices: undefined | number

The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100.

The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero. Default value: 0.

serializedName

serializedName: string = "ServiceTypeHealthPolicy"

type

type: object

className

className: string = "ServiceTypeHealthPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

maxPercentUnhealthyPartitionsPerService

maxPercentUnhealthyPartitionsPerService: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "MaxPercentUnhealthyPartitionsPerService"

type

type: object

name

name: "Number" = "Number"

maxPercentUnhealthyReplicasPerPartition

maxPercentUnhealthyReplicasPerPartition: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "MaxPercentUnhealthyReplicasPerPartition"

type

type: object

name

name: "Number" = "Number"

maxPercentUnhealthyServices

maxPercentUnhealthyServices: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "MaxPercentUnhealthyServices"

type

type: object

name

name: "Number" = "Number"

Const ServiceTypeHealthPolicyMapItem

ServiceTypeHealthPolicyMapItem: object

Defines an item in ServiceTypeHealthPolicyMap.

key

key: string

The key of the service type health policy map item. This is the name of the service type.

value

The value of the service type health policy map item. This is the ServiceTypeHealthPolicy for this service type.

serializedName

serializedName: string = "ServiceTypeHealthPolicyMapItem"

type

type: object

className

className: string = "ServiceTypeHealthPolicyMapItem"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

key

key: object

required

required: true = true

serializedName

serializedName: string = "Key"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "Value"

type

type: object

className

className: string = "ServiceTypeHealthPolicy"

name

name: "Composite" = "Composite"

Const ServiceTypeInfo

ServiceTypeInfo: object

Information about a service type that is defined in a service manifest of a provisioned application type.

Optional isServiceGroup

isServiceGroup: undefined | false | true

Indicates whether the service is a service group. If it is, the property value is true otherwise false.

Optional serviceManifestName

serviceManifestName: undefined | string

The name of the service manifest in which this service type is defined.

Optional serviceManifestVersion

serviceManifestVersion: undefined | string

The version of the service manifest in which this service type is defined.

Optional serviceTypeDescription

serviceTypeDescription: ServiceTypeDescriptionUnion

Describes a service type defined in the service manifest of a provisioned application type. The properties the ones defined in the service manifest.

serializedName

serializedName: string = "ServiceTypeInfo"

type

type: object

className

className: string = "ServiceTypeInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

isServiceGroup

isServiceGroup: object

serializedName

serializedName: string = "IsServiceGroup"

type

type: object

name

name: "Boolean" = "Boolean"

serviceManifestName

serviceManifestName: object

serializedName

serializedName: string = "ServiceManifestName"

type

type: object

name

name: "String" = "String"

serviceManifestVersion

serviceManifestVersion: object

serializedName

serializedName: string = "ServiceManifestVersion"

type

type: object

name

name: "String" = "String"

serviceTypeDescription

serviceTypeDescription: object

serializedName

serializedName: string = "ServiceTypeDescription"

type

type: object

className

className: string = "ServiceTypeDescription"

name

name: "Composite" = "Composite"

Const ServiceTypeManifest

ServiceTypeManifest: object

Contains the manifest describing a service type registered as part of an application in a Service Fabric cluster.

Optional manifest

manifest: undefined | string

The XML manifest as a string.

serializedName

serializedName: string = "ServiceTypeManifest"

type

type: object

className

className: string = "ServiceTypeManifest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

manifest

manifest: object

serializedName

serializedName: string = "Manifest"

type

type: object

name

name: "String" = "String"

Const ServiceUpdateDescription

ServiceUpdateDescription: object

A ServiceUpdateDescription contains all of the information necessary to update a service.

Optional correlationScheme

correlationScheme: ServiceCorrelationDescription[]

The correlation scheme.

Optional defaultMoveCost

defaultMoveCost: MoveCost

The move cost for the service. Possible values include: 'Zero', 'Low', 'Medium', 'High'

Optional flags

flags: undefined | string

Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise 'OR' operator. For example, if the provided value is 6 then the flags for ReplicaRestartWaitDuration (2) and QuorumLossWaitDuration (4) are set.

  • None - Does not indicate any other properties are set. The value is zero.
  • TargetReplicaSetSize/InstanceCount - Indicates whether the TargetReplicaSetSize property (for Stateful services) or the InstanceCount property (for Stateless services) is set. The value is 1.
  • ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 2.
  • QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 4.
  • StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 8.
  • MinReplicaSetSize - Indicates the MinReplicaSetSize property is set. The value is 16.
  • PlacementConstraints - Indicates the PlacementConstraints property is set. The value is 32.
  • PlacementPolicyList - Indicates the ServicePlacementPolicies property is set. The value is 64.
  • Correlation - Indicates the CorrelationScheme property is set. The value is 128.
  • Metrics - Indicates the ServiceLoadMetrics property is set. The value is 256.
  • DefaultMoveCost - Indicates the DefaultMoveCost property is set. The value is 512.
  • ScalingPolicy - Indicates the ScalingPolicies property is set. The value is 1024.

Optional loadMetrics

The service load metrics.

Optional placementConstraints

placementConstraints: undefined | string

The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".

Optional scalingPolicies

scalingPolicies: ScalingPolicyDescription[]

Scaling policies for this service.

serviceKind

serviceKind: "ServiceUpdateDescription"

Polymorphic Discriminator

Optional servicePlacementPolicies

servicePlacementPolicies: ServicePlacementPolicyDescriptionUnion[]

The service placement policies.

serializedName

serializedName: string = "ServiceUpdateDescription"

type

type: object

className

className: string = "ServiceUpdateDescription"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ServiceUpdateDescription"

modelProperties

modelProperties: object

correlationScheme

correlationScheme: object

serializedName

serializedName: string = "CorrelationScheme"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceCorrelationDescription"

name

name: "Composite" = "Composite"

defaultMoveCost

defaultMoveCost: object

serializedName

serializedName: string = "DefaultMoveCost"

type

type: object

name

name: "String" = "String"

flags

flags: object

serializedName

serializedName: string = "Flags"

type

type: object

name

name: "String" = "String"

loadMetrics

loadMetrics: object

serializedName

serializedName: string = "LoadMetrics"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceLoadMetricDescription"

name

name: "Composite" = "Composite"

placementConstraints

placementConstraints: object

serializedName

serializedName: string = "PlacementConstraints"

type

type: object

name

name: "String" = "String"

scalingPolicies

scalingPolicies: object

serializedName

serializedName: string = "ScalingPolicies"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ScalingPolicyDescription"

name

name: "Composite" = "Composite"

serviceKind

serviceKind: object

required

required: true = true

serializedName

serializedName: string = "ServiceKind"

type

type: object

name

name: "String" = "String"

servicePlacementPolicies

servicePlacementPolicies: object

serializedName

serializedName: string = "ServicePlacementPolicies"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServicePlacementPolicyDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "serviceKind"

serializedName

serializedName: string = "ServiceKind"

Const ServicesHealthEvaluation

ServicesHealthEvaluation: object

Represents health evaluation for services of a certain service type belonging to an application, containing health evaluations for each unhealthy service that impacted current aggregated health state. Can be returned when evaluating application health and the aggregated health state is either Error or Warning.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional description

description: undefined | string

Description of the health evaluation, which represents a summary of the evaluation process.

kind

kind: "Services"

Polymorphic Discriminator

Optional maxPercentUnhealthyServices

maxPercentUnhealthyServices: undefined | number

Maximum allowed percentage of unhealthy services from the ServiceTypeHealthPolicy.

Optional serviceTypeName

serviceTypeName: undefined | string

Name of the service type of the services.

Optional totalCount

totalCount: undefined | number

Total number of services of the current service type in the application from the health store.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ServiceHealthEvaluation that impacted the aggregated health.

serializedName

serializedName: string = "Services"

type

type: object

className

className: string = "ServicesHealthEvaluation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = HealthEvaluation.type.polymorphicDiscriminator

uberParent

uberParent: string = "HealthEvaluation"

modelProperties

modelProperties: object

maxPercentUnhealthyServices

maxPercentUnhealthyServices: object

serializedName

serializedName: string = "MaxPercentUnhealthyServices"

type

type: object

name

name: "Number" = "Number"

serviceTypeName

serviceTypeName: object

serializedName

serializedName: string = "ServiceTypeName"

type

type: object

name

name: "String" = "String"

totalCount

totalCount: object

serializedName

serializedName: string = "TotalCount"

type

type: object

name

name: "Number" = "Number"

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

Const Setting

Setting: object

Describes a setting for the container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\secrets". The path for Linux container is "/var/secrets".

Optional name

name: undefined | string

The name of the setting.

Optional value

value: undefined | string

The value of the setting.

serializedName

serializedName: string = "Setting"

type

type: object

className

className: string = "Setting"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const SingletonPartitionInformation

SingletonPartitionInformation: object

Information about a partition that is singleton. The services with singleton partitioning scheme are effectively non-partitioned. They only have one partition.

Optional id

id: undefined | string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

servicePartitionKind

servicePartitionKind: "Singleton"

Polymorphic Discriminator

serializedName

serializedName: string = "Singleton"

type

type: object

className

className: string = "SingletonPartitionInformation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PartitionInformation.type.polymorphicDiscriminator

uberParent

uberParent: string = "PartitionInformation"

modelProperties

modelProperties: object

Const SingletonPartitionSchemeDescription

SingletonPartitionSchemeDescription: object

Describes the partition scheme of a singleton-partitioned, or non-partitioned service.

partitionScheme

partitionScheme: "Singleton"

Polymorphic Discriminator

serializedName

serializedName: string = "Singleton"

type

type: object

className

className: string = "SingletonPartitionSchemeDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PartitionSchemeDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "PartitionSchemeDescription"

modelProperties

modelProperties: object

Const StartClusterUpgradeDescription

StartClusterUpgradeDescription: object

Describes the parameters for starting a cluster upgrade.

Optional applicationHealthPolicyMap

applicationHealthPolicyMap: ApplicationHealthPolicies

Defines the application health policy map used to evaluate the health of an application or one of its children entities.

Optional clusterHealthPolicy

clusterHealthPolicy: ClusterHealthPolicy

Defines a health policy used to evaluate the health of the cluster or of a cluster node.

Optional clusterUpgradeHealthPolicy

clusterUpgradeHealthPolicy: ClusterUpgradeHealthPolicyObject

Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.

Optional codeVersion

codeVersion: undefined | string

The cluster code version.

Optional configVersion

configVersion: undefined | string

The cluster configuration version.

Optional enableDeltaHealthEvaluation

enableDeltaHealthEvaluation: undefined | false | true

When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain.

Optional forceRestart

forceRestart: undefined | false | true

If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).

Optional monitoringPolicy

monitoringPolicy: MonitoringPolicyDescription

Describes the parameters for monitoring an upgrade in Monitored mode.

Optional rollingUpgradeMode

rollingUpgradeMode: UpgradeMode

The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Default value: 'UnmonitoredAuto'.

Optional sortOrder

sortOrder: UpgradeSortOrder

Defines the order in which an upgrade proceeds through the cluster. Possible values include: 'Invalid', 'Default', 'Numeric', 'Lexicographical', 'ReverseNumeric', 'ReverseLexicographical'. Default value: 'Default'.

Optional upgradeKind

upgradeKind: UpgradeKind

The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling'. Default value: 'Rolling'.

Optional upgradeReplicaSetCheckTimeoutInSeconds

upgradeReplicaSetCheckTimeoutInSeconds: undefined | number

The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).

serializedName

serializedName: string = "StartClusterUpgradeDescription"

type

type: object

className

className: string = "StartClusterUpgradeDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationHealthPolicyMap

applicationHealthPolicyMap: object

serializedName

serializedName: string = "ApplicationHealthPolicyMap"

type

type: object

className

className: string = "ApplicationHealthPolicies"

name

name: "Composite" = "Composite"

clusterHealthPolicy

clusterHealthPolicy: object

serializedName

serializedName: string = "ClusterHealthPolicy"

type

type: object

className

className: string = "ClusterHealthPolicy"

name

name: "Composite" = "Composite"

clusterUpgradeHealthPolicy

clusterUpgradeHealthPolicy: object

serializedName

serializedName: string = "ClusterUpgradeHealthPolicy"

type

type: object

className

className: string = "ClusterUpgradeHealthPolicyObject"

name

name: "Composite" = "Composite"

codeVersion

codeVersion: object

serializedName

serializedName: string = "CodeVersion"

type

type: object

name

name: "String" = "String"

configVersion

configVersion: object

serializedName

serializedName: string = "ConfigVersion"

type

type: object

name

name: "String" = "String"

enableDeltaHealthEvaluation

enableDeltaHealthEvaluation: object

serializedName

serializedName: string = "EnableDeltaHealthEvaluation"

type

type: object

name

name: "Boolean" = "Boolean"

forceRestart

forceRestart: object

serializedName

serializedName: string = "ForceRestart"

type

type: object

name

name: "Boolean" = "Boolean"

monitoringPolicy

monitoringPolicy: object

serializedName

serializedName: string = "MonitoringPolicy"

type

type: object

className

className: string = "MonitoringPolicyDescription"

name

name: "Composite" = "Composite"

rollingUpgradeMode

rollingUpgradeMode: object

defaultValue

defaultValue: string = "UnmonitoredAuto"

serializedName

serializedName: string = "RollingUpgradeMode"

type

type: object

name

name: "String" = "String"

sortOrder

sortOrder: object

defaultValue

defaultValue: string = "Default"

serializedName

serializedName: string = "SortOrder"

type

type: object

name

name: "String" = "String"

upgradeKind

upgradeKind: object

defaultValue

defaultValue: string = "Rolling"

serializedName

serializedName: string = "UpgradeKind"

type

type: object

name

name: "String" = "String"

upgradeReplicaSetCheckTimeoutInSeconds

upgradeReplicaSetCheckTimeoutInSeconds: object

serializedName

serializedName: string = "UpgradeReplicaSetCheckTimeoutInSeconds"

type

type: object

name

name: "Number" = "Number"

Const StartedChaosEvent

StartedChaosEvent: object

Describes a Chaos event that gets generated when Chaos is started.

Optional chaosParameters

chaosParameters: ChaosParameters

Defines all the parameters to configure a Chaos run.

kind

kind: "Started"

Polymorphic Discriminator

timeStampUtc

timeStampUtc: Date

The UTC timestamp when this Chaos event was generated.

serializedName

serializedName: string = "Started"

type

type: object

className

className: string = "StartedChaosEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ChaosEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "ChaosEvent"

modelProperties

modelProperties: object

chaosParameters

chaosParameters: object

serializedName

serializedName: string = "ChaosParameters"

type

type: object

className

className: string = "ChaosParameters"

name

name: "Composite" = "Composite"

Const StatefulReplicaHealthReportExpiredEvent

StatefulReplicaHealthReportExpiredEvent: object

Stateful Replica Health Report Expired event.

Optional category

category: undefined | string

The category of event.

description

description: string

Description of report.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

healthState

healthState: string

Describes the property health state.

kind

kind: "StatefulReplicaHealthReportExpired"

Polymorphic Discriminator

partitionId

partitionId: string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

property

property: string

Describes the property.

removeWhenExpired

removeWhenExpired: boolean

Indicates the removal when it expires.

replicaId

replicaId: number

Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.

replicaInstanceId

replicaInstanceId: number

Id of Replica instance.

sequenceNumber

sequenceNumber: number

Sequence number of report.

sourceId

sourceId: string

Id of report source.

sourceUtcTimestamp

sourceUtcTimestamp: Date

Source time.

timeStamp

timeStamp: Date

The time event was logged.

timeToLiveMs

timeToLiveMs: number

Time to live in milli-seconds.

serializedName

serializedName: string = "StatefulReplicaHealthReportExpired"

type

type: object

className

className: string = "StatefulReplicaHealthReportExpiredEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

description

description: object

required

required: true = true

serializedName

serializedName: string = "Description"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

required

required: true = true

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

property

property: object

required

required: true = true

serializedName

serializedName: string = "Property"

type

type: object

name

name: "String" = "String"

removeWhenExpired

removeWhenExpired: object

required

required: true = true

serializedName

serializedName: string = "RemoveWhenExpired"

type

type: object

name

name: "Boolean" = "Boolean"

replicaInstanceId

replicaInstanceId: object

required

required: true = true

serializedName

serializedName: string = "ReplicaInstanceId"

type

type: object

name

name: "Number" = "Number"

sequenceNumber

sequenceNumber: object

required

required: true = true

serializedName

serializedName: string = "SequenceNumber"

type

type: object

name

name: "Number" = "Number"

sourceId

sourceId: object

required

required: true = true

serializedName

serializedName: string = "SourceId"

type

type: object

name

name: "String" = "String"

sourceUtcTimestamp

sourceUtcTimestamp: object

required

required: true = true

serializedName

serializedName: string = "SourceUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

timeToLiveMs

timeToLiveMs: object

required

required: true = true

serializedName

serializedName: string = "TimeToLiveMs"

type

type: object

name

name: "Number" = "Number"

Const StatefulReplicaNewHealthReportEvent

StatefulReplicaNewHealthReportEvent: object

Stateful Replica Health Report Created event.

Optional category

category: undefined | string

The category of event.

description

description: string

Description of report.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

healthState

healthState: string

Describes the property health state.

kind

kind: "StatefulReplicaNewHealthReport"

Polymorphic Discriminator

partitionId

partitionId: string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

property

property: string

Describes the property.

removeWhenExpired

removeWhenExpired: boolean

Indicates the removal when it expires.

replicaId

replicaId: number

Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.

replicaInstanceId

replicaInstanceId: number

Id of Replica instance.

sequenceNumber

sequenceNumber: number

Sequence number of report.

sourceId

sourceId: string

Id of report source.

sourceUtcTimestamp

sourceUtcTimestamp: Date

Source time.

timeStamp

timeStamp: Date

The time event was logged.

timeToLiveMs

timeToLiveMs: number

Time to live in milli-seconds.

serializedName

serializedName: string = "StatefulReplicaNewHealthReport"

type

type: object

className

className: string = "StatefulReplicaNewHealthReportEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

description

description: object

required

required: true = true

serializedName

serializedName: string = "Description"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

required

required: true = true

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

property

property: object

required

required: true = true

serializedName

serializedName: string = "Property"

type

type: object

name

name: "String" = "String"

removeWhenExpired

removeWhenExpired: object

required

required: true = true

serializedName

serializedName: string = "RemoveWhenExpired"

type

type: object

name

name: "Boolean" = "Boolean"

replicaInstanceId

replicaInstanceId: object

required

required: true = true

serializedName

serializedName: string = "ReplicaInstanceId"

type

type: object

name

name: "Number" = "Number"

sequenceNumber

sequenceNumber: object

required

required: true = true

serializedName

serializedName: string = "SequenceNumber"

type

type: object

name

name: "Number" = "Number"

sourceId

sourceId: object

required

required: true = true

serializedName

serializedName: string = "SourceId"

type

type: object

name

name: "String" = "String"

sourceUtcTimestamp

sourceUtcTimestamp: object

required

required: true = true

serializedName

serializedName: string = "SourceUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

timeToLiveMs

timeToLiveMs: object

required

required: true = true

serializedName

serializedName: string = "TimeToLiveMs"

type

type: object

name

name: "Number" = "Number"

Const StatefulServiceDescription

StatefulServiceDescription: object

Describes a stateful service.

Optional applicationName

applicationName: undefined | string

The name of the application, including the 'fabric:' URI scheme.

Optional correlationScheme

correlationScheme: ServiceCorrelationDescription[]

The correlation scheme.

Optional defaultMoveCost

defaultMoveCost: MoveCost

The move cost for the service. Possible values include: 'Zero', 'Low', 'Medium', 'High'

Optional flags

flags: undefined | number

Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise 'OR' operator. For example, if the provided value is 6 then the flags for QuorumLossWaitDuration (2) and StandByReplicaKeepDuration(4) are set.

  • None - Does not indicate any other properties are set. The value is zero.
  • ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 1.
  • QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 2.
  • StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 4.

hasPersistedState

hasPersistedState: boolean

A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false.

Optional initializationData

initializationData: number[]

The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created.

Optional isDefaultMoveCostSpecified

isDefaultMoveCostSpecified: undefined | false | true

Indicates if the DefaultMoveCost property is specified.

minReplicaSetSize

minReplicaSetSize: number

The minimum replica set size as a number.

partitionDescription

partitionDescription: PartitionSchemeDescriptionUnion

The partition description as an object.

Optional placementConstraints

placementConstraints: undefined | string

The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".

Optional quorumLossWaitDurationSeconds

quorumLossWaitDurationSeconds: undefined | number

The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss.

Optional replicaRestartWaitDurationSeconds

replicaRestartWaitDurationSeconds: undefined | number

The duration, in seconds, between when a replica goes down and when a new replica is created.

Optional scalingPolicies

scalingPolicies: ScalingPolicyDescription[]

Scaling policies for this service.

Optional serviceDnsName

serviceDnsName: undefined | string

The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster.

serviceKind

serviceKind: "Stateful"

Polymorphic Discriminator

Optional serviceLoadMetrics

serviceLoadMetrics: ServiceLoadMetricDescription[]

The service load metrics.

serviceName

serviceName: string

The full name of the service with 'fabric:' URI scheme.

Optional servicePackageActivationMode

servicePackageActivationMode: ServicePackageActivationMode

The activation mode of service package to be used for a service. Possible values include: 'SharedProcess', 'ExclusiveProcess'

Optional servicePlacementPolicies

servicePlacementPolicies: ServicePlacementPolicyDescriptionUnion[]

The service placement policies.

serviceTypeName

serviceTypeName: string

Name of the service type as specified in the service manifest.

Optional standByReplicaKeepDurationSeconds

standByReplicaKeepDurationSeconds: undefined | number

The definition on how long StandBy replicas should be maintained before being removed.

targetReplicaSetSize

targetReplicaSetSize: number

The target replica set size as a number.

serializedName

serializedName: string = "Stateful"

type

type: object

className

className: string = "StatefulServiceDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ServiceDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "ServiceDescription"

modelProperties

modelProperties: object

flags

flags: object

serializedName

serializedName: string = "Flags"

type

type: object

name

name: "Number" = "Number"

hasPersistedState

hasPersistedState: object

required

required: true = true

serializedName

serializedName: string = "HasPersistedState"

type

type: object

name

name: "Boolean" = "Boolean"

minReplicaSetSize

minReplicaSetSize: object

required

required: true = true

serializedName

serializedName: string = "MinReplicaSetSize"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

quorumLossWaitDurationSeconds

quorumLossWaitDurationSeconds: object

serializedName

serializedName: string = "QuorumLossWaitDurationSeconds"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 4294967295

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

replicaRestartWaitDurationSeconds

replicaRestartWaitDurationSeconds: object

serializedName

serializedName: string = "ReplicaRestartWaitDurationSeconds"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 4294967295

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

standByReplicaKeepDurationSeconds

standByReplicaKeepDurationSeconds: object

serializedName

serializedName: string = "StandByReplicaKeepDurationSeconds"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 4294967295

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

targetReplicaSetSize

targetReplicaSetSize: object

required

required: true = true

serializedName

serializedName: string = "TargetReplicaSetSize"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const StatefulServiceInfo

StatefulServiceInfo: object

Information about a stateful Service Fabric service.

Optional hasPersistedState

hasPersistedState: undefined | false | true

Whether the service has persisted state.

Optional healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional id

id: undefined | string

The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.

Optional isServiceGroup

isServiceGroup: undefined | false | true

Whether the service is in a service group.

Optional manifestVersion

manifestVersion: undefined | string

The version of the service manifest.

Optional name

name: undefined | string

The full name of the service with 'fabric:' URI scheme.

serviceKind

serviceKind: "Stateful"

Polymorphic Discriminator

Optional serviceStatus

serviceStatus: ServiceStatus

The status of the application. Possible values include: 'Unknown', 'Active', 'Upgrading', 'Deleting', 'Creating', 'Failed'

Optional typeName

typeName: undefined | string

Name of the service type as specified in the service manifest.

serializedName

serializedName: string = "Stateful"

type

type: object

className

className: string = "StatefulServiceInfo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ServiceInfo.type.polymorphicDiscriminator

uberParent

uberParent: string = "ServiceInfo"

modelProperties

modelProperties: object

hasPersistedState

hasPersistedState: object

serializedName

serializedName: string = "HasPersistedState"

type

type: object

name

name: "Boolean" = "Boolean"

Const StatefulServicePartitionInfo

StatefulServicePartitionInfo: object

Information about a partition of a stateful Service Fabric service..

Optional healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional lastQuorumLossDuration

lastQuorumLossDuration: undefined | string

The duration for which this partition was in quorum loss. If the partition is currently in quorum loss, it returns the duration since it has been in that state. This field is using ISO8601 format for specifying the duration.

Optional minReplicaSetSize

minReplicaSetSize: undefined | number

The minimum replica set size as a number.

Optional partitionInformation

partitionInformation: PartitionInformationUnion

Information about the partition identity, partitioning scheme and keys supported by it.

Optional partitionStatus

partitionStatus: ServicePartitionStatus

The status of the service fabric service partition. Possible values include: 'Invalid', 'Ready', 'NotReady', 'InQuorumLoss', 'Reconfiguring', 'Deleting'

Optional primaryEpoch

primaryEpoch: Epoch

An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica.

serviceKind

serviceKind: "Stateful"

Polymorphic Discriminator

Optional targetReplicaSetSize

targetReplicaSetSize: undefined | number

The target replica set size as a number.

serializedName

serializedName: string = "Stateful"

type

type: object

className

className: string = "StatefulServicePartitionInfo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ServicePartitionInfo.type.polymorphicDiscriminator

uberParent

uberParent: string = "ServicePartitionInfo"

modelProperties

modelProperties: object

lastQuorumLossDuration

lastQuorumLossDuration: object

serializedName

serializedName: string = "LastQuorumLossDuration"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

minReplicaSetSize

minReplicaSetSize: object

serializedName

serializedName: string = "MinReplicaSetSize"

type

type: object

name

name: "Number" = "Number"

primaryEpoch

primaryEpoch: object

serializedName

serializedName: string = "PrimaryEpoch"

type

type: object

className

className: string = "Epoch"

name

name: "Composite" = "Composite"

targetReplicaSetSize

targetReplicaSetSize: object

serializedName

serializedName: string = "TargetReplicaSetSize"

type

type: object

name

name: "Number" = "Number"

Const StatefulServiceReplicaHealth

StatefulServiceReplicaHealth: object

Represents the health of the stateful service replica. Contains the replica aggregated health state, the health events and the unhealthy evaluations.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional healthEvents

healthEvents: HealthEvent[]

The list of health events reported on the entity.

Optional healthStatistics

healthStatistics: HealthStatistics

Shows the health statistics for all children types of the queried entity.

Optional partitionId

partitionId: undefined | string

Id of the partition to which this replica belongs.

Optional replicaId

replicaId: undefined | string

Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.

serviceKind

serviceKind: "Stateful"

Polymorphic Discriminator

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.

serializedName

serializedName: string = "Stateful"

type

type: object

className

className: string = "StatefulServiceReplicaHealth"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

replicaId

replicaId: object

serializedName

serializedName: string = "ReplicaId"

type

type: object

name

name: "String" = "String"

Const StatefulServiceReplicaHealthState

StatefulServiceReplicaHealthState: object

Represents the health state of the stateful service replica, which contains the replica ID and the aggregated health state.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional partitionId

partitionId: undefined | string

The ID of the partition to which this replica belongs.

Optional replicaId

replicaId: undefined | string

Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.

serviceKind

serviceKind: "Stateful"

Polymorphic Discriminator

serializedName

serializedName: string = "Stateful"

type

type: object

className

className: string = "StatefulServiceReplicaHealthState"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

replicaId

replicaId: object

serializedName

serializedName: string = "ReplicaId"

type

type: object

name

name: "String" = "String"

Const StatefulServiceReplicaInfo

StatefulServiceReplicaInfo: object

Represents a stateful service replica. This includes information about the identity, role, status, health, node name, uptime, and other details about the replica.

Optional address

address: undefined | string

The address the replica is listening on.

Optional healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional lastInBuildDurationInSeconds

lastInBuildDurationInSeconds: undefined | string

The last in build duration of the replica in seconds.

Optional nodeName

nodeName: undefined | string

The name of a Service Fabric node.

Optional replicaId

replicaId: undefined | string

Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.

Optional replicaRole

replicaRole: ReplicaRole

The role of a replica of a stateful service. Possible values include: 'Unknown', 'None', 'Primary', 'IdleSecondary', 'ActiveSecondary'

Optional replicaStatus

replicaStatus: ReplicaStatus

The status of a replica of a service. Possible values include: 'Invalid', 'InBuild', 'Standby', 'Ready', 'Down', 'Dropped'

serviceKind

serviceKind: "Stateful"

Polymorphic Discriminator

serializedName

serializedName: string = "Stateful"

type

type: object

className

className: string = "StatefulServiceReplicaInfo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ReplicaInfo.type.polymorphicDiscriminator

uberParent

uberParent: string = "ReplicaInfo"

modelProperties

modelProperties: object

replicaId

replicaId: object

serializedName

serializedName: string = "ReplicaId"

type

type: object

name

name: "String" = "String"

replicaRole

replicaRole: object

serializedName

serializedName: string = "ReplicaRole"

type

type: object

name

name: "String" = "String"

Const StatefulServiceTypeDescription

StatefulServiceTypeDescription: object

Describes a stateful service type defined in the service manifest of a provisioned application type.

Optional extensions

List of service type extensions.

Optional hasPersistedState

hasPersistedState: undefined | false | true

A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false.

Optional isStateful

isStateful: undefined | false | true

Indicates whether the service type is a stateful service type or a stateless service type. This property is true if the service type is a stateful service type, false otherwise.

kind

kind: "Stateful"

Polymorphic Discriminator

Optional loadMetrics

The service load metrics is given as an array of ServiceLoadMetricDescription objects.

Optional placementConstraints

placementConstraints: undefined | string

The placement constraint to be used when instantiating this service in a Service Fabric cluster.

Optional servicePlacementPolicies

servicePlacementPolicies: ServicePlacementPolicyDescriptionUnion[]

List of service placement policy descriptions.

Optional serviceTypeName

serviceTypeName: undefined | string

Name of the service type as specified in the service manifest.

serializedName

serializedName: string = "Stateful"

type

type: object

className

className: string = "StatefulServiceTypeDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ServiceTypeDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "ServiceTypeDescription"

modelProperties

modelProperties: object

hasPersistedState

hasPersistedState: object

serializedName

serializedName: string = "HasPersistedState"

type

type: object

name

name: "Boolean" = "Boolean"

Const StatefulServiceUpdateDescription

StatefulServiceUpdateDescription: object

Describes an update for a stateful service.

Optional correlationScheme

correlationScheme: ServiceCorrelationDescription[]

The correlation scheme.

Optional defaultMoveCost

defaultMoveCost: MoveCost

The move cost for the service. Possible values include: 'Zero', 'Low', 'Medium', 'High'

Optional flags

flags: undefined | string

Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise 'OR' operator. For example, if the provided value is 6 then the flags for ReplicaRestartWaitDuration (2) and QuorumLossWaitDuration (4) are set.

  • None - Does not indicate any other properties are set. The value is zero.
  • TargetReplicaSetSize/InstanceCount - Indicates whether the TargetReplicaSetSize property (for Stateful services) or the InstanceCount property (for Stateless services) is set. The value is 1.
  • ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 2.
  • QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 4.
  • StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 8.
  • MinReplicaSetSize - Indicates the MinReplicaSetSize property is set. The value is 16.
  • PlacementConstraints - Indicates the PlacementConstraints property is set. The value is 32.
  • PlacementPolicyList - Indicates the ServicePlacementPolicies property is set. The value is 64.
  • Correlation - Indicates the CorrelationScheme property is set. The value is 128.
  • Metrics - Indicates the ServiceLoadMetrics property is set. The value is 256.
  • DefaultMoveCost - Indicates the DefaultMoveCost property is set. The value is 512.
  • ScalingPolicy - Indicates the ScalingPolicies property is set. The value is 1024.

Optional loadMetrics

The service load metrics.

Optional minReplicaSetSize

minReplicaSetSize: undefined | number

The minimum replica set size as a number.

Optional placementConstraints

placementConstraints: undefined | string

The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".

Optional quorumLossWaitDurationSeconds

quorumLossWaitDurationSeconds: undefined | string

The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss.

Optional replicaRestartWaitDurationSeconds

replicaRestartWaitDurationSeconds: undefined | string

The duration, in seconds, between when a replica goes down and when a new replica is created.

Optional scalingPolicies

scalingPolicies: ScalingPolicyDescription[]

Scaling policies for this service.

serviceKind

serviceKind: "Stateful"

Polymorphic Discriminator

Optional servicePlacementPolicies

servicePlacementPolicies: ServicePlacementPolicyDescriptionUnion[]

The service placement policies.

Optional standByReplicaKeepDurationSeconds

standByReplicaKeepDurationSeconds: undefined | string

The definition on how long StandBy replicas should be maintained before being removed.

Optional targetReplicaSetSize

targetReplicaSetSize: undefined | number

The target replica set size as a number.

serializedName

serializedName: string = "Stateful"

type

type: object

className

className: string = "StatefulServiceUpdateDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ServiceUpdateDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "ServiceUpdateDescription"

modelProperties

modelProperties: object

minReplicaSetSize

minReplicaSetSize: object

serializedName

serializedName: string = "MinReplicaSetSize"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

quorumLossWaitDurationSeconds

quorumLossWaitDurationSeconds: object

serializedName

serializedName: string = "QuorumLossWaitDurationSeconds"

type

type: object

name

name: "String" = "String"

replicaRestartWaitDurationSeconds

replicaRestartWaitDurationSeconds: object

serializedName

serializedName: string = "ReplicaRestartWaitDurationSeconds"

type

type: object

name

name: "String" = "String"

standByReplicaKeepDurationSeconds

standByReplicaKeepDurationSeconds: object

serializedName

serializedName: string = "StandByReplicaKeepDurationSeconds"

type

type: object

name

name: "String" = "String"

targetReplicaSetSize

targetReplicaSetSize: object

serializedName

serializedName: string = "TargetReplicaSetSize"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const StatelessReplicaHealthReportExpiredEvent

StatelessReplicaHealthReportExpiredEvent: object

Stateless Replica Health Report Expired event.

Optional category

category: undefined | string

The category of event.

description

description: string

Description of report.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

healthState

healthState: string

Describes the property health state.

kind

kind: "StatelessReplicaHealthReportExpired"

Polymorphic Discriminator

partitionId

partitionId: string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

property

property: string

Describes the property.

removeWhenExpired

removeWhenExpired: boolean

Indicates the removal when it expires.

replicaId

replicaId: number

Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.

sequenceNumber

sequenceNumber: number

Sequence number of report.

sourceId

sourceId: string

Id of report source.

sourceUtcTimestamp

sourceUtcTimestamp: Date

Source time.

timeStamp

timeStamp: Date

The time event was logged.

timeToLiveMs

timeToLiveMs: number

Time to live in milli-seconds.

serializedName

serializedName: string = "StatelessReplicaHealthReportExpired"

type

type: object

className

className: string = "StatelessReplicaHealthReportExpiredEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

description

description: object

required

required: true = true

serializedName

serializedName: string = "Description"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

required

required: true = true

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

property

property: object

required

required: true = true

serializedName

serializedName: string = "Property"

type

type: object

name

name: "String" = "String"

removeWhenExpired

removeWhenExpired: object

required

required: true = true

serializedName

serializedName: string = "RemoveWhenExpired"

type

type: object

name

name: "Boolean" = "Boolean"

sequenceNumber

sequenceNumber: object

required

required: true = true

serializedName

serializedName: string = "SequenceNumber"

type

type: object

name

name: "Number" = "Number"

sourceId

sourceId: object

required

required: true = true

serializedName

serializedName: string = "SourceId"

type

type: object

name

name: "String" = "String"

sourceUtcTimestamp

sourceUtcTimestamp: object

required

required: true = true

serializedName

serializedName: string = "SourceUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

timeToLiveMs

timeToLiveMs: object

required

required: true = true

serializedName

serializedName: string = "TimeToLiveMs"

type

type: object

name

name: "Number" = "Number"

Const StatelessReplicaNewHealthReportEvent

StatelessReplicaNewHealthReportEvent: object

Stateless Replica Health Report Created event.

Optional category

category: undefined | string

The category of event.

description

description: string

Description of report.

eventInstanceId

eventInstanceId: string

The identifier for the FabricEvent instance.

Optional hasCorrelatedEvents

hasCorrelatedEvents: undefined | false | true

Shows there is existing related events available.

healthState

healthState: string

Describes the property health state.

kind

kind: "StatelessReplicaNewHealthReport"

Polymorphic Discriminator

partitionId

partitionId: string

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

property

property: string

Describes the property.

removeWhenExpired

removeWhenExpired: boolean

Indicates the removal when it expires.

replicaId

replicaId: number

Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.

sequenceNumber

sequenceNumber: number

Sequence number of report.

sourceId

sourceId: string

Id of report source.

sourceUtcTimestamp

sourceUtcTimestamp: Date

Source time.

timeStamp

timeStamp: Date

The time event was logged.

timeToLiveMs

timeToLiveMs: number

Time to live in milli-seconds.

serializedName

serializedName: string = "StatelessReplicaNewHealthReport"

type

type: object

className

className: string = "StatelessReplicaNewHealthReportEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricEvent"

modelProperties

modelProperties: object

description

description: object

required

required: true = true

serializedName

serializedName: string = "Description"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

required

required: true = true

serializedName

serializedName: string = "HealthState"

type

type: object

name

name: "String" = "String"

property

property: object

required

required: true = true

serializedName

serializedName: string = "Property"

type

type: object

name

name: "String" = "String"

removeWhenExpired

removeWhenExpired: object

required

required: true = true

serializedName

serializedName: string = "RemoveWhenExpired"

type

type: object

name

name: "Boolean" = "Boolean"

sequenceNumber

sequenceNumber: object

required

required: true = true

serializedName

serializedName: string = "SequenceNumber"

type

type: object

name

name: "Number" = "Number"

sourceId

sourceId: object

required

required: true = true

serializedName

serializedName: string = "SourceId"

type

type: object

name

name: "String" = "String"

sourceUtcTimestamp

sourceUtcTimestamp: object

required

required: true = true

serializedName

serializedName: string = "SourceUtcTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

timeToLiveMs

timeToLiveMs: object

required

required: true = true

serializedName

serializedName: string = "TimeToLiveMs"

type

type: object

name

name: "Number" = "Number"

Const StatelessServiceDescription

StatelessServiceDescription: object

Describes a stateless service.

Optional applicationName

applicationName: undefined | string

The name of the application, including the 'fabric:' URI scheme.

Optional correlationScheme

correlationScheme: ServiceCorrelationDescription[]

The correlation scheme.

Optional defaultMoveCost

defaultMoveCost: MoveCost

The move cost for the service. Possible values include: 'Zero', 'Low', 'Medium', 'High'

Optional initializationData

initializationData: number[]

The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created.

instanceCount

instanceCount: number

The instance count.

Optional isDefaultMoveCostSpecified

isDefaultMoveCostSpecified: undefined | false | true

Indicates if the DefaultMoveCost property is specified.

partitionDescription

partitionDescription: PartitionSchemeDescriptionUnion

The partition description as an object.

Optional placementConstraints

placementConstraints: undefined | string

The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".

Optional scalingPolicies

scalingPolicies: ScalingPolicyDescription[]

Scaling policies for this service.

Optional serviceDnsName

serviceDnsName: undefined | string

The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster.

serviceKind

serviceKind: "Stateless"

Polymorphic Discriminator

Optional serviceLoadMetrics

serviceLoadMetrics: ServiceLoadMetricDescription[]

The service load metrics.

serviceName

serviceName: string

The full name of the service with 'fabric:' URI scheme.

Optional servicePackageActivationMode

servicePackageActivationMode: ServicePackageActivationMode

The activation mode of service package to be used for a service. Possible values include: 'SharedProcess', 'ExclusiveProcess'

Optional servicePlacementPolicies

servicePlacementPolicies: ServicePlacementPolicyDescriptionUnion[]

The service placement policies.

serviceTypeName

serviceTypeName: string

Name of the service type as specified in the service manifest.

serializedName

serializedName: string = "Stateless"

type

type: object

className

className: string = "StatelessServiceDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ServiceDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "ServiceDescription"

modelProperties

modelProperties: object

instanceCount

instanceCount: object

required

required: true = true

serializedName

serializedName: string = "InstanceCount"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = -1

type

type: object

name

name: "Number" = "Number"

Const StatelessServiceInfo

StatelessServiceInfo: object

Information about a stateless Service Fabric service.

Optional healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional id

id: undefined | string

The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.

Optional isServiceGroup

isServiceGroup: undefined | false | true

Whether the service is in a service group.

Optional manifestVersion

manifestVersion: undefined | string

The version of the service manifest.

Optional name

name: undefined | string

The full name of the service with 'fabric:' URI scheme.

serviceKind

serviceKind: "Stateless"

Polymorphic Discriminator

Optional serviceStatus

serviceStatus: ServiceStatus

The status of the application. Possible values include: 'Unknown', 'Active', 'Upgrading', 'Deleting', 'Creating', 'Failed'

Optional typeName

typeName: undefined | string

Name of the service type as specified in the service manifest.

serializedName

serializedName: string = "Stateless"

type

type: object

className

className: string = "StatelessServiceInfo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ServiceInfo.type.polymorphicDiscriminator

uberParent

uberParent: string = "ServiceInfo"

modelProperties

modelProperties: object

Const StatelessServiceInstanceHealth

StatelessServiceInstanceHealth: object

Represents the health of the stateless service instance. Contains the instance aggregated health state, the health events and the unhealthy evaluations.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional healthEvents

healthEvents: HealthEvent[]

The list of health events reported on the entity.

Optional healthStatistics

healthStatistics: HealthStatistics

Shows the health statistics for all children types of the queried entity.

Optional instanceId

instanceId: undefined | string

Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId.

Optional partitionId

partitionId: undefined | string

Id of the partition to which this replica belongs.

serviceKind

serviceKind: "Stateless"

Polymorphic Discriminator

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.

serializedName

serializedName: string = "Stateless"

type

type: object

className

className: string = "StatelessServiceInstanceHealth"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

instanceId

instanceId: object

serializedName

serializedName: string = "InstanceId"

type

type: object

name

name: "String" = "String"

Const StatelessServiceInstanceHealthState

StatelessServiceInstanceHealthState: object

Represents the health state of the stateless service instance, which contains the instance ID and the aggregated health state.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional partitionId

partitionId: undefined | string

The ID of the partition to which this replica belongs.

Optional replicaId

replicaId: undefined | string

Id of the stateless service instance on the wire this field is called ReplicaId.

serviceKind

serviceKind: "Stateless"

Polymorphic Discriminator

serializedName

serializedName: string = "Stateless"

type

type: object

className

className: string = "StatelessServiceInstanceHealthState"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

replicaId

replicaId: object

serializedName

serializedName: string = "ReplicaId"

type

type: object

name

name: "String" = "String"

Const StatelessServiceInstanceInfo

StatelessServiceInstanceInfo: object

Represents a stateless service instance. This includes information about the identity, status, health, node name, uptime, and other details about the instance.

Optional address

address: undefined | string

The address the replica is listening on.

Optional healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional instanceId

instanceId: undefined | string

Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId.

Optional lastInBuildDurationInSeconds

lastInBuildDurationInSeconds: undefined | string

The last in build duration of the replica in seconds.

Optional nodeName

nodeName: undefined | string

The name of a Service Fabric node.

Optional replicaStatus

replicaStatus: ReplicaStatus

The status of a replica of a service. Possible values include: 'Invalid', 'InBuild', 'Standby', 'Ready', 'Down', 'Dropped'

serviceKind

serviceKind: "Stateless"

Polymorphic Discriminator

serializedName

serializedName: string = "Stateless"

type

type: object

className

className: string = "StatelessServiceInstanceInfo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ReplicaInfo.type.polymorphicDiscriminator

uberParent

uberParent: string = "ReplicaInfo"

modelProperties

modelProperties: object

instanceId

instanceId: object

serializedName

serializedName: string = "InstanceId"

type

type: object

name

name: "String" = "String"

Const StatelessServicePartitionInfo

StatelessServicePartitionInfo: object

Information about a partition of a stateless Service Fabric service.

Optional healthState

healthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional instanceCount

instanceCount: undefined | number

Number of instances of this partition.

Optional partitionInformation

partitionInformation: PartitionInformationUnion

Information about the partition identity, partitioning scheme and keys supported by it.

Optional partitionStatus

partitionStatus: ServicePartitionStatus

The status of the service fabric service partition. Possible values include: 'Invalid', 'Ready', 'NotReady', 'InQuorumLoss', 'Reconfiguring', 'Deleting'

serviceKind

serviceKind: "Stateless"

Polymorphic Discriminator

serializedName

serializedName: string = "Stateless"

type

type: object

className

className: string = "StatelessServicePartitionInfo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ServicePartitionInfo.type.polymorphicDiscriminator

uberParent

uberParent: string = "ServicePartitionInfo"

modelProperties

modelProperties: object

instanceCount

instanceCount: object

serializedName

serializedName: string = "InstanceCount"

type

type: object

name

name: "Number" = "Number"

Const StatelessServiceTypeDescription

StatelessServiceTypeDescription: object

Describes a stateless service type defined in the service manifest of a provisioned application type.

Optional extensions

List of service type extensions.

Optional isStateful

isStateful: undefined | false | true

Indicates whether the service type is a stateful service type or a stateless service type. This property is true if the service type is a stateful service type, false otherwise.

kind

kind: "Stateless"

Polymorphic Discriminator

Optional loadMetrics

The service load metrics is given as an array of ServiceLoadMetricDescription objects.

Optional placementConstraints

placementConstraints: undefined | string

The placement constraint to be used when instantiating this service in a Service Fabric cluster.

Optional servicePlacementPolicies

servicePlacementPolicies: ServicePlacementPolicyDescriptionUnion[]

List of service placement policy descriptions.

Optional serviceTypeName

serviceTypeName: undefined | string

Name of the service type as specified in the service manifest.

Optional useImplicitHost

useImplicitHost: undefined | false | true

A flag indicating if this type is not implemented and hosted by a user service process, but is implicitly hosted by a system created process. This value is true for services using the guest executable services, false otherwise.

serializedName

serializedName: string = "Stateless"

type

type: object

className

className: string = "StatelessServiceTypeDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ServiceTypeDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "ServiceTypeDescription"

modelProperties

modelProperties: object

useImplicitHost

useImplicitHost: object

serializedName

serializedName: string = "UseImplicitHost"

type

type: object

name

name: "Boolean" = "Boolean"

Const StatelessServiceUpdateDescription

StatelessServiceUpdateDescription: object

Describes an update for a stateless service.

Optional correlationScheme

correlationScheme: ServiceCorrelationDescription[]

The correlation scheme.

Optional defaultMoveCost

defaultMoveCost: MoveCost

The move cost for the service. Possible values include: 'Zero', 'Low', 'Medium', 'High'

Optional flags

flags: undefined | string

Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise 'OR' operator. For example, if the provided value is 6 then the flags for ReplicaRestartWaitDuration (2) and QuorumLossWaitDuration (4) are set.

  • None - Does not indicate any other properties are set. The value is zero.
  • TargetReplicaSetSize/InstanceCount - Indicates whether the TargetReplicaSetSize property (for Stateful services) or the InstanceCount property (for Stateless services) is set. The value is 1.
  • ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 2.
  • QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 4.
  • StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 8.
  • MinReplicaSetSize - Indicates the MinReplicaSetSize property is set. The value is 16.
  • PlacementConstraints - Indicates the PlacementConstraints property is set. The value is 32.
  • PlacementPolicyList - Indicates the ServicePlacementPolicies property is set. The value is 64.
  • Correlation - Indicates the CorrelationScheme property is set. The value is 128.
  • Metrics - Indicates the ServiceLoadMetrics property is set. The value is 256.
  • DefaultMoveCost - Indicates the DefaultMoveCost property is set. The value is 512.
  • ScalingPolicy - Indicates the ScalingPolicies property is set. The value is 1024.

Optional instanceCount

instanceCount: undefined | number

The instance count.

Optional loadMetrics

The service load metrics.

Optional placementConstraints

placementConstraints: undefined | string

The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".

Optional scalingPolicies

scalingPolicies: ScalingPolicyDescription[]

Scaling policies for this service.

serviceKind

serviceKind: "Stateless"

Polymorphic Discriminator

Optional servicePlacementPolicies

servicePlacementPolicies: ServicePlacementPolicyDescriptionUnion[]

The service placement policies.

serializedName

serializedName: string = "Stateless"

type

type: object

className

className: string = "StatelessServiceUpdateDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ServiceUpdateDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "ServiceUpdateDescription"

modelProperties

modelProperties: object

instanceCount

instanceCount: object

serializedName

serializedName: string = "InstanceCount"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = -1

type

type: object

name

name: "Number" = "Number"

Const StoppedChaosEvent

StoppedChaosEvent: object

Describes a Chaos event that gets generated when Chaos stops because either the user issued a stop or the time to run was up.

kind

kind: "Stopped"

Polymorphic Discriminator

Optional reason

reason: undefined | string

Describes why Chaos stopped. Chaos can stop because of StopChaos API call or the timeToRun provided in ChaosParameters is over.

timeStampUtc

timeStampUtc: Date

The UTC timestamp when this Chaos event was generated.

serializedName

serializedName: string = "Stopped"

type

type: object

className

className: string = "StoppedChaosEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ChaosEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "ChaosEvent"

modelProperties

modelProperties: object

reason

reason: object

serializedName

serializedName: string = "Reason"

type

type: object

name

name: "String" = "String"

Const StringPropertyValue

StringPropertyValue: object

Describes a Service Fabric property value of type String.

data

data: string

The data of the property value.

kind

kind: "String"

Polymorphic Discriminator

serializedName

serializedName: string = "String"

type

type: object

className

className: string = "StringPropertyValue"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PropertyValue.type.polymorphicDiscriminator

uberParent

uberParent: string = "PropertyValue"

modelProperties

modelProperties: object

data

data: object

required

required: true = true

serializedName

serializedName: string = "Data"

type

type: object

name

name: "String" = "String"

Const SuccessfulPropertyBatchInfo

SuccessfulPropertyBatchInfo: object

Derived from PropertyBatchInfo. Represents the property batch succeeding. Contains the results of any "Get" operations in the batch.

kind

kind: "Successful"

Polymorphic Discriminator

Optional properties

properties: undefined | object

A map containing the properties that were requested through any "Get" property batch operations. The key represents the index of the "Get" operation in the original request, in string form. The value is the property. If a property is not found, it will not be in the map.

serializedName

serializedName: string = "Successful"

type

type: object

className

className: string = "SuccessfulPropertyBatchInfo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PropertyBatchInfo.type.polymorphicDiscriminator

uberParent

uberParent: string = "PropertyBatchInfo"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "Properties"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "PropertyInfo"

name

name: "Composite" = "Composite"

Const SystemApplicationHealthEvaluation

SystemApplicationHealthEvaluation: object

Represents health evaluation for the fabric:/System application, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state of the cluster is either Error or Warning.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional description

description: undefined | string

Description of the health evaluation, which represents a summary of the evaluation process.

kind

kind: "SystemApplication"

Polymorphic Discriminator

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

List of unhealthy evaluations that led to the current aggregated health state of the system application. The types of the unhealthy evaluations can be DeployedApplicationsHealthEvaluation, ServicesHealthEvaluation or EventHealthEvaluation.

serializedName

serializedName: string = "SystemApplication"

type

type: object

className

className: string = "SystemApplicationHealthEvaluation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = HealthEvaluation.type.polymorphicDiscriminator

uberParent

uberParent: string = "HealthEvaluation"

modelProperties

modelProperties: object

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

Const TcpConfig

TcpConfig: object

Describes the tcp configuration for external connectivity for this network.

destination

destination: GatewayDestination

Describes destination endpoint for routing traffic.

name

name: string

tcp gateway config name.

port

port: number

Specifies the port at which the service endpoint below needs to be exposed.

serializedName

serializedName: string = "TcpConfig"

type

type: object

className

className: string = "TcpConfig"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

destination

destination: object

required

required: true = true

serializedName

serializedName: string = "destination"

type

type: object

className

className: string = "GatewayDestination"

name

name: "Composite" = "Composite"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

port

port: object

required

required: true = true

serializedName

serializedName: string = "port"

type

type: object

name

name: "Number" = "Number"

Const TestErrorChaosEvent

TestErrorChaosEvent: object

Describes a Chaos event that gets generated when an unexpected event occurs in the Chaos engine. For example, due to the cluster snapshot being inconsistent, while faulting an entity, Chaos found that the entity was already faulted -- which would be an unexpected event.

kind

kind: "TestError"

Polymorphic Discriminator

Optional reason

reason: undefined | string

Describes why TestErrorChaosEvent was generated. For example, Chaos tries to fault a partition but finds that the partition is no longer fault tolerant, then a TestErrorEvent gets generated with the reason stating that the partition is not fault tolerant.

timeStampUtc

timeStampUtc: Date

The UTC timestamp when this Chaos event was generated.

serializedName

serializedName: string = "TestError"

type

type: object

className

className: string = "TestErrorChaosEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ChaosEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "ChaosEvent"

modelProperties

modelProperties: object

reason

reason: object

serializedName

serializedName: string = "Reason"

type

type: object

name

name: "String" = "String"

Const TimeBasedBackupScheduleDescription

TimeBasedBackupScheduleDescription: object

Describes the time based backup schedule.

Optional runDays

runDays: DayOfWeek[]

List of days of a week when to trigger the periodic backup. This is valid only when the backup schedule frequency type is weekly.

runTimes

runTimes: Date[] | string[]

Represents the list of exact time during the day in ISO8601 format. Like '19:00:00' will represent '7PM' during the day. Date specified along with time will be ignored.

scheduleFrequencyType

scheduleFrequencyType: BackupScheduleFrequencyType

Describes the frequency with which to run the time based backup schedule. Possible values include: 'Invalid', 'Daily', 'Weekly'

scheduleKind

scheduleKind: "TimeBased"

Polymorphic Discriminator

serializedName

serializedName: string = "TimeBased"

type

type: object

className

className: string = "TimeBasedBackupScheduleDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = BackupScheduleDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "BackupScheduleDescription"

modelProperties

modelProperties: object

runDays

runDays: object

serializedName

serializedName: string = "RunDays"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

runTimes

runTimes: object

required

required: true = true

serializedName

serializedName: string = "RunTimes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "DateTime" = "DateTime"

scheduleFrequencyType

scheduleFrequencyType: object

required

required: true = true

serializedName

serializedName: string = "ScheduleFrequencyType"

type

type: object

name

name: "String" = "String"

Const TimeOfDay

TimeOfDay: object

Defines an hour and minute of the day specified in 24 hour time.

Optional hour

hour: undefined | number

Represents the hour of the day. Value must be between 0 and 23 inclusive.

Optional minute

minute: undefined | number

Represents the minute of the hour. Value must be between 0 to 59 inclusive.

serializedName

serializedName: string = "TimeOfDay"

type

type: object

className

className: string = "TimeOfDay"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

hour

hour: object

serializedName

serializedName: string = "Hour"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 23

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

minute

minute: object

serializedName

serializedName: string = "Minute"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 59

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

Const TimeRange

TimeRange: object

Defines a time range in a 24 hour day specified by a start and end time.

Optional endTime

endTime: TimeOfDay

Defines an hour and minute of the day specified in 24 hour time.

Optional startTime

startTime: TimeOfDay

Defines an hour and minute of the day specified in 24 hour time.

serializedName

serializedName: string = "TimeRange"

type

type: object

className

className: string = "TimeRange"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endTime

endTime: object

serializedName

serializedName: string = "EndTime"

type

type: object

className

className: string = "TimeOfDay"

name

name: "Composite" = "Composite"

startTime

startTime: object

serializedName

serializedName: string = "StartTime"

type

type: object

className

className: string = "TimeOfDay"

name

name: "Composite" = "Composite"

Const UniformInt64RangePartitionSchemeDescription

UniformInt64RangePartitionSchemeDescription: object

Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.

count

count: number

The number of partitions.

highKey

highKey: string

String indicating the upper bound of the partition key range that should be split between the partitions.

lowKey

lowKey: string

String indicating the lower bound of the partition key range that should be split between the partitions.

partitionScheme

partitionScheme: "UniformInt64Range"

Polymorphic Discriminator

serializedName

serializedName: string = "UniformInt64Range"

type

type: object

className

className: string = "UniformInt64RangePartitionSchemeDescription"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PartitionSchemeDescription.type.polymorphicDiscriminator

uberParent

uberParent: string = "PartitionSchemeDescription"

modelProperties

modelProperties: object

count

count: object

required

required: true = true

serializedName

serializedName: string = "Count"

type

type: object

name

name: "Number" = "Number"

highKey

highKey: object

required

required: true = true

serializedName

serializedName: string = "HighKey"

type

type: object

name

name: "String" = "String"

lowKey

lowKey: object

required

required: true = true

serializedName

serializedName: string = "LowKey"

type

type: object

name

name: "String" = "String"

Const UnplacedReplicaInformation

UnplacedReplicaInformation: object

Contains information for an unplaced replica.

Optional partitionId

partitionId: undefined | string

The ID of the partition.

Optional serviceName

serviceName: undefined | string

The name of the service.

Optional unplacedReplicaDetails

unplacedReplicaDetails: string[]

List of reasons due to which a replica cannot be placed.

serializedName

serializedName: string = "UnplacedReplicaInformation"

type

type: object

className

className: string = "UnplacedReplicaInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

partitionId

partitionId: object

serializedName

serializedName: string = "PartitionId"

type

type: object

name

name: "Uuid" = "Uuid"

serviceName

serviceName: object

serializedName

serializedName: string = "ServiceName"

type

type: object

name

name: "String" = "String"

unplacedReplicaDetails

unplacedReplicaDetails: object

serializedName

serializedName: string = "UnplacedReplicaDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const UnprovisionApplicationTypeDescriptionInfo

UnprovisionApplicationTypeDescriptionInfo: object

Describes the operation to unregister or unprovision an application type and its version that was registered with the Service Fabric.

applicationTypeVersion

applicationTypeVersion: string

The version of the application type as defined in the application manifest.

Optional async

async: undefined | false | true

The flag indicating whether or not unprovision should occur asynchronously. When set to true, the unprovision operation returns when the request is accepted by the system, and the unprovision operation continues without any timeout limit. The default value is false. However, we recommend setting it to true for large application packages that were provisioned.

serializedName

serializedName: string = "UnprovisionApplicationTypeDescriptionInfo"

type

type: object

className

className: string = "UnprovisionApplicationTypeDescriptionInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationTypeVersion

applicationTypeVersion: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeVersion"

type

type: object

name

name: "String" = "String"

async

async: object

serializedName

serializedName: string = "Async"

type

type: object

name

name: "Boolean" = "Boolean"

Const UnprovisionFabricDescription

UnprovisionFabricDescription: object

Describes the parameters for unprovisioning a cluster.

Optional codeVersion

codeVersion: undefined | string

The cluster code package version.

Optional configVersion

configVersion: undefined | string

The cluster manifest version.

serializedName

serializedName: string = "UnprovisionFabricDescription"

type

type: object

className

className: string = "UnprovisionFabricDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

codeVersion

codeVersion: object

serializedName

serializedName: string = "CodeVersion"

type

type: object

name

name: "String" = "String"

configVersion

configVersion: object

serializedName

serializedName: string = "ConfigVersion"

type

type: object

name

name: "String" = "String"

Const UpdateClusterUpgradeDescription

UpdateClusterUpgradeDescription: object

Parameters for updating a cluster upgrade.

Optional applicationHealthPolicyMap

applicationHealthPolicyMap: ApplicationHealthPolicies

Defines the application health policy map used to evaluate the health of an application or one of its children entities.

Optional clusterHealthPolicy

clusterHealthPolicy: ClusterHealthPolicy

Defines a health policy used to evaluate the health of the cluster or of a cluster node.

Optional clusterUpgradeHealthPolicy

clusterUpgradeHealthPolicy: ClusterUpgradeHealthPolicyObject

Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.

Optional enableDeltaHealthEvaluation

enableDeltaHealthEvaluation: undefined | false | true

When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain.

Optional updateDescription

Describes the parameters for updating a rolling upgrade of application or cluster.

Optional upgradeKind

upgradeKind: UpgradeType

The type of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling', 'Rolling_ForceRestart'. Default value: 'Rolling'.

serializedName

serializedName: string = "UpdateClusterUpgradeDescription"

type

type: object

className

className: string = "UpdateClusterUpgradeDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationHealthPolicyMap

applicationHealthPolicyMap: object

serializedName

serializedName: string = "ApplicationHealthPolicyMap"

type

type: object

className

className: string = "ApplicationHealthPolicies"

name

name: "Composite" = "Composite"

clusterHealthPolicy

clusterHealthPolicy: object

serializedName

serializedName: string = "ClusterHealthPolicy"

type

type: object

className

className: string = "ClusterHealthPolicy"

name

name: "Composite" = "Composite"

clusterUpgradeHealthPolicy

clusterUpgradeHealthPolicy: object

serializedName

serializedName: string = "ClusterUpgradeHealthPolicy"

type

type: object

className

className: string = "ClusterUpgradeHealthPolicyObject"

name

name: "Composite" = "Composite"

enableDeltaHealthEvaluation

enableDeltaHealthEvaluation: object

serializedName

serializedName: string = "EnableDeltaHealthEvaluation"

type

type: object

name

name: "Boolean" = "Boolean"

updateDescription

updateDescription: object

serializedName

serializedName: string = "UpdateDescription"

type

type: object

className

className: string = "RollingUpgradeUpdateDescription"

name

name: "Composite" = "Composite"

upgradeKind

upgradeKind: object

defaultValue

defaultValue: string = "Rolling"

serializedName

serializedName: string = "UpgradeKind"

type

type: object

name

name: "String" = "String"

Const UpgradeDomainDeltaNodesCheckHealthEvaluation

UpgradeDomainDeltaNodesCheckHealthEvaluation: object

Represents health evaluation for delta unhealthy cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned during cluster upgrade when cluster aggregated health state is Warning or Error.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional baselineErrorCount

baselineErrorCount: undefined | number

Number of upgrade domain nodes with aggregated heath state Error in the health store at the beginning of the cluster upgrade.

Optional baselineTotalCount

baselineTotalCount: undefined | number

Total number of upgrade domain nodes in the health store at the beginning of the cluster upgrade.

Optional description

description: undefined | string

Description of the health evaluation, which represents a summary of the evaluation process.

kind

kind: "UpgradeDomainDeltaNodesCheck"

Polymorphic Discriminator

Optional maxPercentDeltaUnhealthyNodes

maxPercentDeltaUnhealthyNodes: undefined | number

Maximum allowed percentage of upgrade domain delta unhealthy nodes from the ClusterUpgradeHealthPolicy.

Optional totalCount

totalCount: undefined | number

Total number of upgrade domain nodes in the health store.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health.

Optional upgradeDomainName

upgradeDomainName: undefined | string

Name of the upgrade domain where nodes health is currently evaluated.

serializedName

serializedName: string = "UpgradeDomainDeltaNodesCheck"

type

type: object

className

className: string = "UpgradeDomainDeltaNodesCheckHealthEvaluation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = HealthEvaluation.type.polymorphicDiscriminator

uberParent

uberParent: string = "HealthEvaluation"

modelProperties

modelProperties: object

baselineErrorCount

baselineErrorCount: object

serializedName

serializedName: string = "BaselineErrorCount"

type

type: object

name

name: "Number" = "Number"

baselineTotalCount

baselineTotalCount: object

serializedName

serializedName: string = "BaselineTotalCount"

type

type: object

name

name: "Number" = "Number"

maxPercentDeltaUnhealthyNodes

maxPercentDeltaUnhealthyNodes: object

serializedName

serializedName: string = "MaxPercentDeltaUnhealthyNodes"

type

type: object

name

name: "Number" = "Number"

totalCount

totalCount: object

serializedName

serializedName: string = "TotalCount"

type

type: object

name

name: "Number" = "Number"

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

upgradeDomainName

upgradeDomainName: object

serializedName

serializedName: string = "UpgradeDomainName"

type

type: object

name

name: "String" = "String"

Const UpgradeDomainInfo

UpgradeDomainInfo: object

Information about an upgrade domain.

Optional name

name: undefined | string

The name of the upgrade domain

Optional state

The state of the upgrade domain. Possible values include: 'Invalid', 'Pending', 'InProgress', 'Completed'

serializedName

serializedName: string = "UpgradeDomainInfo"

type

type: object

className

className: string = "UpgradeDomainInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "Name"

type

type: object

name

name: "String" = "String"

state

state: object

serializedName

serializedName: string = "State"

type

type: object

name

name: "String" = "String"

Const UpgradeDomainNodesHealthEvaluation

UpgradeDomainNodesHealthEvaluation: object

Represents health evaluation for cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health during cluster upgrade and the aggregated health state is either Error or Warning.

Optional aggregatedHealthState

aggregatedHealthState: HealthState

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

Optional description

description: undefined | string

Description of the health evaluation, which represents a summary of the evaluation process.

kind

kind: "UpgradeDomainNodes"

Polymorphic Discriminator

Optional maxPercentUnhealthyNodes

maxPercentUnhealthyNodes: undefined | number

Maximum allowed percentage of unhealthy nodes from the ClusterHealthPolicy.

Optional totalCount

totalCount: undefined | number

Total number of nodes in the current upgrade domain.

Optional unhealthyEvaluations

unhealthyEvaluations: HealthEvaluationWrapper[]

List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health.

Optional upgradeDomainName

upgradeDomainName: undefined | string

Name of the upgrade domain where nodes health is currently evaluated.

serializedName

serializedName: string = "UpgradeDomainNodes"

type

type: object

className

className: string = "UpgradeDomainNodesHealthEvaluation"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = HealthEvaluation.type.polymorphicDiscriminator

uberParent

uberParent: string = "HealthEvaluation"

modelProperties

modelProperties: object

maxPercentUnhealthyNodes

maxPercentUnhealthyNodes: object

serializedName

serializedName: string = "MaxPercentUnhealthyNodes"

type

type: object

name

name: "Number" = "Number"

totalCount

totalCount: object

serializedName

serializedName: string = "TotalCount"

type

type: object

name

name: "Number" = "Number"

unhealthyEvaluations

unhealthyEvaluations: object

serializedName

serializedName: string = "UnhealthyEvaluations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthEvaluationWrapper"

name

name: "Composite" = "Composite"

upgradeDomainName

upgradeDomainName: object

serializedName

serializedName: string = "UpgradeDomainName"

type

type: object

name

name: "String" = "String"

Const UpgradeOrchestrationServiceState

UpgradeOrchestrationServiceState: object

Service state of Service Fabric Upgrade Orchestration Service.

Optional serviceState

serviceState: undefined | string

The state of Service Fabric Upgrade Orchestration Service.

serializedName

serializedName: string = "UpgradeOrchestrationServiceState"

type

type: object

className

className: string = "UpgradeOrchestrationServiceState"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

serviceState

serviceState: object

serializedName

serializedName: string = "ServiceState"

type

type: object

name

name: "String" = "String"

Const UpgradeOrchestrationServiceStateSummary

UpgradeOrchestrationServiceStateSummary: object

Service state summary of Service Fabric Upgrade Orchestration Service.

Optional currentCodeVersion

currentCodeVersion: undefined | string

The current code version of the cluster.

Optional currentManifestVersion

currentManifestVersion: undefined | string

The current manifest version of the cluster.

Optional pendingUpgradeType

pendingUpgradeType: undefined | string

The type of the pending upgrade of the cluster.

Optional targetCodeVersion

targetCodeVersion: undefined | string

The target code version of the cluster.

Optional targetManifestVersion

targetManifestVersion: undefined | string

The target manifest version of the cluster.

serializedName

serializedName: string = "UpgradeOrchestrationServiceStateSummary"

type

type: object

className

className: string = "UpgradeOrchestrationServiceStateSummary"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

currentCodeVersion

currentCodeVersion: object

serializedName

serializedName: string = "CurrentCodeVersion"

type

type: object

name

name: "String" = "String"

currentManifestVersion

currentManifestVersion: object

serializedName

serializedName: string = "CurrentManifestVersion"

type

type: object

name

name: "String" = "String"

pendingUpgradeType

pendingUpgradeType: object

serializedName

serializedName: string = "PendingUpgradeType"

type

type: object

name

name: "String" = "String"

targetCodeVersion

targetCodeVersion: object

serializedName

serializedName: string = "TargetCodeVersion"

type

type: object

name

name: "String" = "String"

targetManifestVersion

targetManifestVersion: object

serializedName

serializedName: string = "TargetManifestVersion"

type

type: object

name

name: "String" = "String"

Const UploadChunkRange

UploadChunkRange: object

Information about which portion of the file to upload.

Optional endPosition

endPosition: undefined | string

The end position of the portion of the file. It's represented by the number of bytes.

Optional startPosition

startPosition: undefined | string

The start position of the portion of the file. It's represented by the number of bytes.

serializedName

serializedName: string = "UploadChunkRange"

type

type: object

className

className: string = "UploadChunkRange"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endPosition

endPosition: object

serializedName

serializedName: string = "EndPosition"

type

type: object

name

name: "String" = "String"

startPosition

startPosition: object

serializedName

serializedName: string = "StartPosition"

type

type: object

name

name: "String" = "String"

Const UploadSession

UploadSession: object

Information about a image store upload session

Optional uploadSessions

uploadSessions: UploadSessionInfo[]

When querying upload session by upload session ID, the result contains only one upload session. When querying upload session by image store relative path, the result might contain multiple upload sessions.

serializedName

serializedName: string = "UploadSession"

type

type: object

className

className: string = "UploadSession"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

uploadSessions

uploadSessions: object

serializedName

serializedName: string = "UploadSessions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "UploadSessionInfo"

name

name: "Composite" = "Composite"

Const UploadSessionInfo

UploadSessionInfo: object

Information about an image store upload session. A session is associated with a relative path in the image store.

Optional expectedRanges

expectedRanges: UploadChunkRange[]

List of chunk ranges that image store has not received yet.

Optional fileSize

fileSize: undefined | string

The size in bytes of the uploading file.

Optional modifiedDate

modifiedDate: Date

The date and time when the upload session was last modified.

Optional sessionId

sessionId: undefined | string

A unique ID of the upload session. A session ID can be reused only if the session was committed or removed.

Optional storeRelativePath

storeRelativePath: undefined | string

The remote location within image store. This path is relative to the image store root.

serializedName

serializedName: string = "UploadSessionInfo"

type

type: object

className

className: string = "UploadSessionInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

expectedRanges

expectedRanges: object

serializedName

serializedName: string = "ExpectedRanges"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "UploadChunkRange"

name

name: "Composite" = "Composite"

fileSize

fileSize: object

serializedName

serializedName: string = "FileSize"

type

type: object

name

name: "String" = "String"

modifiedDate

modifiedDate: object

serializedName

serializedName: string = "ModifiedDate"

type

type: object

name

name: "DateTime" = "DateTime"

sessionId

sessionId: object

serializedName

serializedName: string = "SessionId"

type

type: object

name

name: "Uuid" = "Uuid"

storeRelativePath

storeRelativePath: object

serializedName

serializedName: string = "StoreRelativePath"

type

type: object

name

name: "String" = "String"

Const ValidationFailedChaosEvent

ValidationFailedChaosEvent: object

Chaos event corresponding to a failure during validation.

kind

kind: "ValidationFailed"

Polymorphic Discriminator

Optional reason

reason: undefined | string

Describes why the ValidationFailedChaosEvent was generated. This may happen because more than MaxPercentUnhealthyNodes are unhealthy for more than MaxClusterStabilizationTimeout. This reason will be in the Reason property of the ValidationFailedChaosEvent as a string.

timeStampUtc

timeStampUtc: Date

The UTC timestamp when this Chaos event was generated.

serializedName

serializedName: string = "ValidationFailed"

type

type: object

className

className: string = "ValidationFailedChaosEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ChaosEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "ChaosEvent"

modelProperties

modelProperties: object

reason

reason: object

serializedName

serializedName: string = "Reason"

type

type: object

name

name: "String" = "String"

Const VolumeProviderParametersAzureFile

VolumeProviderParametersAzureFile: object

This type describes a volume provided by an Azure Files file share.

Optional accountKey

accountKey: undefined | string

Access key of the Azure storage account for the File Share.

accountName

accountName: string

Name of the Azure storage account for the File Share.

shareName

shareName: string

Name of the Azure Files file share that provides storage for the volume.

serializedName

serializedName: string = "VolumeProviderParametersAzureFile"

type

type: object

className

className: string = "VolumeProviderParametersAzureFile"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

accountKey

accountKey: object

serializedName

serializedName: string = "accountKey"

type

type: object

name

name: "String" = "String"

accountName

accountName: object

required

required: true = true

serializedName

serializedName: string = "accountName"

type

type: object

name

name: "String" = "String"

shareName

shareName: object

required

required: true = true

serializedName

serializedName: string = "shareName"

type

type: object

name

name: "String" = "String"

Const VolumeReference

VolumeReference: object

Describes a reference to a volume resource.

destinationPath

destinationPath: string

The path within the container at which the volume should be mounted. Only valid path characters are allowed.

name

name: string

Name of the volume being referenced.

Optional readOnly

readOnly: undefined | false | true

The flag indicating whether the volume is read only. Default is 'false'.

serializedName

serializedName: string = "VolumeReference"

type

type: object

className

className: string = "VolumeReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

destinationPath

destinationPath: object

required

required: true = true

serializedName

serializedName: string = "destinationPath"

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

readOnly

readOnly: object

serializedName

serializedName: string = "readOnly"

type

type: object

name

name: "Boolean" = "Boolean"

Const VolumeResourceDescription

VolumeResourceDescription: object

This type describes a volume resource.

Optional azureFileParameters

This type describes a volume provided by an Azure Files file share.

Optional description

description: undefined | string

User readable description of the volume.

name

name: string

Name of the Volume resource.

Optional status

Status of the volume. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional statusDetails

statusDetails: undefined | string

Gives additional information about the current status of the volume. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VolumeResourceDescription"

type

type: object

className

className: string = "VolumeResourceDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

azureFileParameters

azureFileParameters: object

serializedName

serializedName: string = "properties.azureFileParameters"

type

type: object

className

className: string = "VolumeProviderParametersAzureFile"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provider

provider: object

defaultValue

defaultValue: string = "SFAzureFile"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "properties.provider"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

statusDetails

statusDetails: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.statusDetails"

type

type: object

name

name: "String" = "String"

Const WaitForInbuildReplicaSafetyCheck

WaitForInbuildReplicaSafetyCheck: object

Safety check that waits for the replica build operation to finish. This indicates that there is a replica that is going through the copy or is providing data for building another replica. Bring the node down will abort this copy operation which are typically expensive involving data movements.

kind

kind: "WaitForInbuildReplica"

Polymorphic Discriminator

Optional partitionId

partitionId: undefined | string

Id of the partition which is undergoing the safety check.

serializedName

serializedName: string = "WaitForInbuildReplica"

type

type: object

className

className: string = "WaitForInbuildReplicaSafetyCheck"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = SafetyCheck.type.polymorphicDiscriminator

uberParent

uberParent: string = "SafetyCheck"

modelProperties

modelProperties: object

Const WaitForPrimaryPlacementSafetyCheck

WaitForPrimaryPlacementSafetyCheck: object

Safety check that waits for the primary replica that was moved out of the node due to upgrade to be placed back again on that node.

kind

kind: "WaitForPrimaryPlacement"

Polymorphic Discriminator

Optional partitionId

partitionId: undefined | string

Id of the partition which is undergoing the safety check.

serializedName

serializedName: string = "WaitForPrimaryPlacement"

type

type: object

className

className: string = "WaitForPrimaryPlacementSafetyCheck"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = SafetyCheck.type.polymorphicDiscriminator

uberParent

uberParent: string = "SafetyCheck"

modelProperties

modelProperties: object

Const WaitForPrimarySwapSafetyCheck

WaitForPrimarySwapSafetyCheck: object

Safety check that waits for the primary replica to be moved out of the node before starting an upgrade to ensure the availability of the primary replica for the partition.

kind

kind: "WaitForPrimarySwap"

Polymorphic Discriminator

Optional partitionId

partitionId: undefined | string

Id of the partition which is undergoing the safety check.

serializedName

serializedName: string = "WaitForPrimarySwap"

type

type: object

className

className: string = "WaitForPrimarySwapSafetyCheck"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = SafetyCheck.type.polymorphicDiscriminator

uberParent

uberParent: string = "SafetyCheck"

modelProperties

modelProperties: object

Const WaitForReconfigurationSafetyCheck

WaitForReconfigurationSafetyCheck: object

Safety check that waits for the current reconfiguration of the partition to be completed before starting an upgrade.

kind

kind: "WaitForReconfiguration"

Polymorphic Discriminator

Optional partitionId

partitionId: undefined | string

Id of the partition which is undergoing the safety check.

serializedName

serializedName: string = "WaitForReconfiguration"

type

type: object

className

className: string = "WaitForReconfigurationSafetyCheck"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = SafetyCheck.type.polymorphicDiscriminator

uberParent

uberParent: string = "SafetyCheck"

modelProperties

modelProperties: object

Const WaitingChaosEvent

WaitingChaosEvent: object

Describes a Chaos event that gets generated when Chaos is waiting for the cluster to become ready for faulting, for example, Chaos may be waiting for the on-going upgrade to finish.

kind

kind: "Waiting"

Polymorphic Discriminator

Optional reason

reason: undefined | string

Describes why the WaitingChaosEvent was generated, for example, due to a cluster upgrade.

timeStampUtc

timeStampUtc: Date

The UTC timestamp when this Chaos event was generated.

serializedName

serializedName: string = "Waiting"

type

type: object

className

className: string = "WaitingChaosEvent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ChaosEvent.type.polymorphicDiscriminator

uberParent

uberParent: string = "ChaosEvent"

modelProperties

modelProperties: object

reason

reason: object

serializedName

serializedName: string = "Reason"

type

type: object

name

name: "String" = "String"

Const apiVersion0

apiVersion0: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "6.0"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion1

apiVersion1: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "6.4"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion2

apiVersion2: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "6.3"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion3

apiVersion3: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "6.2"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion4

apiVersion4: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "6.1"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion5

apiVersion5: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "6.5"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion6

apiVersion6: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "6.0-preview"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion7

apiVersion7: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "6.4-preview"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion8

apiVersion8: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "6.2-preview"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const applicationDefinitionKindFilter

applicationDefinitionKindFilter: object

parameterPath

parameterPath: string[] = ["options","applicationDefinitionKindFilter"]

mapper

mapper: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "ApplicationDefinitionKindFilter"

type

type: object

name

name: "Number" = "Number"

Const applicationId

applicationId: object

parameterPath

parameterPath: string = "applicationId"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "applicationId"

type

type: object

name

name: "String" = "String"

Const applicationResourceName

applicationResourceName: object

parameterPath

parameterPath: string = "applicationResourceName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "applicationResourceName"

type

type: object

name

name: "String" = "String"

Const applicationTypeDefinitionKindFilter

applicationTypeDefinitionKindFilter: object

parameterPath

parameterPath: string[] = ["options","applicationTypeDefinitionKindFilter"]

mapper

mapper: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "ApplicationTypeDefinitionKindFilter"

type

type: object

name

name: "Number" = "Number"

Const applicationTypeName0

applicationTypeName0: object

parameterPath

parameterPath: string = "applicationTypeName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "applicationTypeName"

type

type: object

name

name: "String" = "String"

Const applicationTypeName1

applicationTypeName1: object

parameterPath

parameterPath: string[] = ["options","applicationTypeName"]

mapper

mapper: object

serializedName

serializedName: string = "ApplicationTypeName"

type

type: object

name

name: "String" = "String"

Const applicationTypeVersion0

applicationTypeVersion0: object

parameterPath

parameterPath: string[] = ["options","applicationTypeVersion"]

mapper

mapper: object

serializedName

serializedName: string = "ApplicationTypeVersion"

type

type: object

name

name: "String" = "String"

Const applicationTypeVersion1

applicationTypeVersion1: object

parameterPath

parameterPath: string = "applicationTypeVersion"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "ApplicationTypeVersion"

type

type: object

name

name: "String" = "String"

Const applicationsHealthStateFilter

applicationsHealthStateFilter: object

parameterPath

parameterPath: string[] = ["options","applicationsHealthStateFilter"]

mapper

mapper: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "ApplicationsHealthStateFilter"

type

type: object

name

name: "Number" = "Number"

Const backupPolicyName

backupPolicyName: object

parameterPath

parameterPath: string = "backupPolicyName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "backupPolicyName"

type

type: object

name

name: "String" = "String"

Const backupTimeout

backupTimeout: object

parameterPath

parameterPath: string[] = ["options","backupTimeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 10

serializedName

serializedName: string = "BackupTimeout"

type

type: object

name

name: "Number" = "Number"

Const codePackageInstanceId

codePackageInstanceId: object

parameterPath

parameterPath: string = "codePackageInstanceId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "CodePackageInstanceId"

type

type: object

name

name: "String" = "String"

Const codePackageName0

codePackageName0: object

parameterPath

parameterPath: string[] = ["options","codePackageName"]

mapper

mapper: object

serializedName

serializedName: string = "CodePackageName"

type

type: object

name

name: "String" = "String"

Const codePackageName1

codePackageName1: object

parameterPath

parameterPath: string = "codePackageName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "CodePackageName"

type

type: object

name

name: "String" = "String"

Const codePackageName2

codePackageName2: object

parameterPath

parameterPath: string = "codePackageName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "codePackageName"

type

type: object

name

name: "String" = "String"

Const codeVersion

codeVersion: object

parameterPath

parameterPath: string[] = ["options","codeVersion"]

mapper

mapper: object

serializedName

serializedName: string = "CodeVersion"

type

type: object

name

name: "String" = "String"

Const command

command: object

parameterPath

parameterPath: string = "command"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "Command"

type

type: object

name

name: "String" = "String"

Const configVersion

configVersion: object

parameterPath

parameterPath: string[] = ["options","configVersion"]

mapper

mapper: object

serializedName

serializedName: string = "ConfigVersion"

type

type: object

name

name: "String" = "String"

Const configurationApiVersion

configurationApiVersion: object

parameterPath

parameterPath: string = "configurationApiVersion"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "ConfigurationApiVersion"

type

type: object

name

name: "String" = "String"

Const contentPath

contentPath: object

parameterPath

parameterPath: string = "contentPath"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "contentPath"

type

type: object

name

name: "String" = "String"

Const contentRange

contentRange: object

parameterPath

parameterPath: string = "contentRange"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "Content-Range"

type

type: object

name

name: "String" = "String"

Const continuationToken

continuationToken: object

parameterPath

parameterPath: string[] = ["options","continuationToken"]

skipEncoding

skipEncoding: true = true

mapper

mapper: object

serializedName

serializedName: string = "ContinuationToken"

type

type: object

name

name: "String" = "String"

Const currentNodeName

currentNodeName: object

parameterPath

parameterPath: string = "currentNodeName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "CurrentNodeName"

type

type: object

name

name: "String" = "String"

Const dataLossMode

dataLossMode: object

parameterPath

parameterPath: string = "dataLossMode"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "DataLossMode"

type

type: object

name

name: "String" = "String"

Const deployedApplicationsHealthStateFilter

deployedApplicationsHealthStateFilter: object

parameterPath

parameterPath: string[] = ["options","deployedApplicationsHealthStateFilter"]

mapper

mapper: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "DeployedApplicationsHealthStateFilter"

type

type: object

name

name: "Number" = "Number"

Const deployedServicePackagesHealthStateFilter

deployedServicePackagesHealthStateFilter: object

parameterPath

parameterPath: string[] = ["options","deployedServicePackagesHealthStateFilter"]

mapper

mapper: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "DeployedServicePackagesHealthStateFilter"

type

type: object

name

name: "Number" = "Number"

Const deploymentName

deploymentName: object

parameterPath

parameterPath: string = "deploymentName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "deploymentName"

type

type: object

name

name: "String" = "String"

Const discriminators

discriminators: object

ApplicationScopedVolumeCreationParameters

ApplicationScopedVolumeCreationParameters: CompositeMapper = ApplicationScopedVolumeCreationParameters

ApplicationScopedVolumeCreationParameters.ServiceFabricVolumeDisk

ApplicationScopedVolumeCreationParameters.ServiceFabricVolumeDisk: CompositeMapper = ApplicationScopedVolumeCreationParametersServiceFabricVolumeDisk

AutoScalingMechanism

AutoScalingMechanism: CompositeMapper = AutoScalingMechanism

AutoScalingMechanism.AddRemoveReplica

AutoScalingMechanism.AddRemoveReplica: CompositeMapper = AddRemoveReplicaScalingMechanism

AutoScalingMetric

AutoScalingMetric: CompositeMapper = AutoScalingMetric

AutoScalingMetric.Resource

AutoScalingMetric.Resource: CompositeMapper = AutoScalingResourceMetric

AutoScalingTrigger

AutoScalingTrigger: CompositeMapper = AutoScalingTrigger

AutoScalingTrigger.AverageLoad

AutoScalingTrigger.AverageLoad: CompositeMapper = AverageLoadScalingTrigger

BackupConfigurationInfo

BackupConfigurationInfo: CompositeMapper = BackupConfigurationInfo

BackupConfigurationInfo.Application

BackupConfigurationInfo.Application: CompositeMapper = ApplicationBackupConfigurationInfo

BackupConfigurationInfo.Partition

BackupConfigurationInfo.Partition: CompositeMapper = PartitionBackupConfigurationInfo

BackupConfigurationInfo.Service

BackupConfigurationInfo.Service: CompositeMapper = ServiceBackupConfigurationInfo

BackupEntity

BackupEntity: CompositeMapper = BackupEntity

BackupEntity.Application

BackupEntity.Application: CompositeMapper = ApplicationBackupEntity

BackupEntity.Partition

BackupEntity.Partition: CompositeMapper = PartitionBackupEntity

BackupEntity.Service

BackupEntity.Service: CompositeMapper = ServiceBackupEntity

BackupScheduleDescription

BackupScheduleDescription: CompositeMapper = BackupScheduleDescription

BackupScheduleDescription.FrequencyBased

BackupScheduleDescription.FrequencyBased: CompositeMapper = FrequencyBasedBackupScheduleDescription

BackupScheduleDescription.TimeBased

BackupScheduleDescription.TimeBased: CompositeMapper = TimeBasedBackupScheduleDescription

BackupStorageDescription

BackupStorageDescription: CompositeMapper = BackupStorageDescription

BackupStorageDescription.AzureBlobStore

BackupStorageDescription.AzureBlobStore: CompositeMapper = AzureBlobBackupStorageDescription

BackupStorageDescription.FileShare

BackupStorageDescription.FileShare: CompositeMapper = FileShareBackupStorageDescription

ChaosEvent

ChaosEvent: CompositeMapper = ChaosEvent

ChaosEvent.ExecutingFaults

ChaosEvent.ExecutingFaults: CompositeMapper = ExecutingFaultsChaosEvent

ChaosEvent.Started

ChaosEvent.Started: CompositeMapper = StartedChaosEvent

ChaosEvent.Stopped

ChaosEvent.Stopped: CompositeMapper = StoppedChaosEvent

ChaosEvent.TestError

ChaosEvent.TestError: CompositeMapper = TestErrorChaosEvent

ChaosEvent.ValidationFailed

ChaosEvent.ValidationFailed: CompositeMapper = ValidationFailedChaosEvent

ChaosEvent.Waiting

ChaosEvent.Waiting: CompositeMapper = WaitingChaosEvent

DeployedServiceReplicaDetailInfo

DeployedServiceReplicaDetailInfo: CompositeMapper = DeployedServiceReplicaDetailInfo

DeployedServiceReplicaDetailInfo.Stateful

DeployedServiceReplicaDetailInfo.Stateful: CompositeMapper = DeployedStatefulServiceReplicaDetailInfo

DeployedServiceReplicaDetailInfo.Stateless

DeployedServiceReplicaDetailInfo.Stateless: CompositeMapper = DeployedStatelessServiceInstanceDetailInfo

DeployedServiceReplicaInfo

DeployedServiceReplicaInfo: CompositeMapper = DeployedServiceReplicaInfo

DeployedServiceReplicaInfo.Stateful

DeployedServiceReplicaInfo.Stateful: CompositeMapper = DeployedStatefulServiceReplicaInfo

DeployedServiceReplicaInfo.Stateless

DeployedServiceReplicaInfo.Stateless: CompositeMapper = DeployedStatelessServiceInstanceInfo

DiagnosticsSinkProperties

DiagnosticsSinkProperties: CompositeMapper = DiagnosticsSinkProperties

DiagnosticsSinkProperties.AzureInternalMonitoringPipeline

DiagnosticsSinkProperties.AzureInternalMonitoringPipeline: CompositeMapper = AzureInternalMonitoringPipelineSinkDescription

EntityHealth.ReplicaHealth

EntityHealth.ReplicaHealth: CompositeMapper = ReplicaHealth

EntityHealth.Stateful

EntityHealth.Stateful: CompositeMapper = StatefulServiceReplicaHealth

EntityHealth.Stateless

EntityHealth.Stateless: CompositeMapper = StatelessServiceInstanceHealth

EntityHealthState.ReplicaHealthState

EntityHealthState.ReplicaHealthState: CompositeMapper = ReplicaHealthState

EntityHealthState.Stateful

EntityHealthState.Stateful: CompositeMapper = StatefulServiceReplicaHealthState

EntityHealthState.Stateless

EntityHealthState.Stateless: CompositeMapper = StatelessServiceInstanceHealthState

FabricEvent

FabricEvent: CompositeMapper = FabricEvent

FabricEvent.ApplicationContainerInstanceExited

FabricEvent.ApplicationContainerInstanceExited: CompositeMapper = ApplicationContainerInstanceExitedEvent

FabricEvent.ApplicationCreated

FabricEvent.ApplicationCreated: CompositeMapper = ApplicationCreatedEvent

FabricEvent.ApplicationDeleted

FabricEvent.ApplicationDeleted: CompositeMapper = ApplicationDeletedEvent

FabricEvent.ApplicationEvent

FabricEvent.ApplicationEvent: CompositeMapper = ApplicationEvent

FabricEvent.ApplicationHealthReportExpired

FabricEvent.ApplicationHealthReportExpired: CompositeMapper = ApplicationHealthReportExpiredEvent

FabricEvent.ApplicationNewHealthReport

FabricEvent.ApplicationNewHealthReport: CompositeMapper = ApplicationNewHealthReportEvent

FabricEvent.ApplicationProcessExited

FabricEvent.ApplicationProcessExited: CompositeMapper = ApplicationProcessExitedEvent

FabricEvent.ApplicationUpgradeCompleted

FabricEvent.ApplicationUpgradeCompleted: CompositeMapper = ApplicationUpgradeCompletedEvent

FabricEvent.ApplicationUpgradeDomainCompleted

FabricEvent.ApplicationUpgradeDomainCompleted: CompositeMapper = ApplicationUpgradeDomainCompletedEvent

FabricEvent.ApplicationUpgradeRollbackCompleted

FabricEvent.ApplicationUpgradeRollbackCompleted: CompositeMapper = ApplicationUpgradeRollbackCompletedEvent

FabricEvent.ApplicationUpgradeRollbackStarted

FabricEvent.ApplicationUpgradeRollbackStarted: CompositeMapper = ApplicationUpgradeRollbackStartedEvent

FabricEvent.ApplicationUpgradeStarted

FabricEvent.ApplicationUpgradeStarted: CompositeMapper = ApplicationUpgradeStartedEvent

FabricEvent.ChaosCodePackageRestartScheduled

FabricEvent.ChaosCodePackageRestartScheduled: CompositeMapper = ChaosCodePackageRestartScheduledEvent

FabricEvent.ChaosNodeRestartScheduled

FabricEvent.ChaosNodeRestartScheduled: CompositeMapper = ChaosNodeRestartScheduledEvent

FabricEvent.ChaosPartitionPrimaryMoveScheduled

FabricEvent.ChaosPartitionPrimaryMoveScheduled: CompositeMapper = ChaosPartitionPrimaryMoveScheduledEvent

FabricEvent.ChaosPartitionSecondaryMoveScheduled

FabricEvent.ChaosPartitionSecondaryMoveScheduled: CompositeMapper = ChaosPartitionSecondaryMoveScheduledEvent

FabricEvent.ChaosReplicaRemovalScheduled

FabricEvent.ChaosReplicaRemovalScheduled: CompositeMapper = ChaosReplicaRemovalScheduledEvent

FabricEvent.ChaosReplicaRestartScheduled

FabricEvent.ChaosReplicaRestartScheduled: CompositeMapper = ChaosReplicaRestartScheduledEvent

FabricEvent.ChaosStarted

FabricEvent.ChaosStarted: CompositeMapper = ChaosStartedEvent

FabricEvent.ChaosStopped

FabricEvent.ChaosStopped: CompositeMapper = ChaosStoppedEvent

FabricEvent.ClusterEvent

FabricEvent.ClusterEvent: CompositeMapper = ClusterEvent

FabricEvent.ClusterHealthReportExpired

FabricEvent.ClusterHealthReportExpired: CompositeMapper = ClusterHealthReportExpiredEvent

FabricEvent.ClusterNewHealthReport

FabricEvent.ClusterNewHealthReport: CompositeMapper = ClusterNewHealthReportEvent

FabricEvent.ClusterUpgradeCompleted

FabricEvent.ClusterUpgradeCompleted: CompositeMapper = ClusterUpgradeCompletedEvent

FabricEvent.ClusterUpgradeDomainCompleted

FabricEvent.ClusterUpgradeDomainCompleted: CompositeMapper = ClusterUpgradeDomainCompletedEvent

FabricEvent.ClusterUpgradeRollbackCompleted

FabricEvent.ClusterUpgradeRollbackCompleted: CompositeMapper = ClusterUpgradeRollbackCompletedEvent

FabricEvent.ClusterUpgradeRollbackStarted

FabricEvent.ClusterUpgradeRollbackStarted: CompositeMapper = ClusterUpgradeRollbackStartedEvent

FabricEvent.ClusterUpgradeStarted

FabricEvent.ClusterUpgradeStarted: CompositeMapper = ClusterUpgradeStartedEvent

FabricEvent.ContainerInstanceEvent

FabricEvent.ContainerInstanceEvent: CompositeMapper = ContainerInstanceEvent

FabricEvent.DeployedApplicationHealthReportExpired

FabricEvent.DeployedApplicationHealthReportExpired: CompositeMapper = DeployedApplicationHealthReportExpiredEvent

FabricEvent.DeployedApplicationNewHealthReport

FabricEvent.DeployedApplicationNewHealthReport: CompositeMapper = DeployedApplicationNewHealthReportEvent

FabricEvent.DeployedServicePackageHealthReportExpired

FabricEvent.DeployedServicePackageHealthReportExpired: CompositeMapper = DeployedServicePackageHealthReportExpiredEvent

FabricEvent.DeployedServicePackageNewHealthReport

FabricEvent.DeployedServicePackageNewHealthReport: CompositeMapper = DeployedServicePackageNewHealthReportEvent

FabricEvent.NodeAborted

FabricEvent.NodeAborted: CompositeMapper = NodeAbortedEvent

FabricEvent.NodeAddedToCluster

FabricEvent.NodeAddedToCluster: CompositeMapper = NodeAddedToClusterEvent

FabricEvent.NodeClosed

FabricEvent.NodeClosed: CompositeMapper = NodeClosedEvent

FabricEvent.NodeDeactivateCompleted

FabricEvent.NodeDeactivateCompleted: CompositeMapper = NodeDeactivateCompletedEvent

FabricEvent.NodeDeactivateStarted

FabricEvent.NodeDeactivateStarted: CompositeMapper = NodeDeactivateStartedEvent

FabricEvent.NodeDown

FabricEvent.NodeDown: CompositeMapper = NodeDownEvent

FabricEvent.NodeEvent

FabricEvent.NodeEvent: CompositeMapper = NodeEvent

FabricEvent.NodeHealthReportExpired

FabricEvent.NodeHealthReportExpired: CompositeMapper = NodeHealthReportExpiredEvent

FabricEvent.NodeNewHealthReport

FabricEvent.NodeNewHealthReport: CompositeMapper = NodeNewHealthReportEvent

FabricEvent.NodeOpenFailed

FabricEvent.NodeOpenFailed: CompositeMapper = NodeOpenFailedEvent

FabricEvent.NodeOpenSucceeded

FabricEvent.NodeOpenSucceeded: CompositeMapper = NodeOpenSucceededEvent

FabricEvent.NodeRemovedFromCluster

FabricEvent.NodeRemovedFromCluster: CompositeMapper = NodeRemovedFromClusterEvent

FabricEvent.NodeUp

FabricEvent.NodeUp: CompositeMapper = NodeUpEvent

FabricEvent.PartitionAnalysisEvent

FabricEvent.PartitionAnalysisEvent: CompositeMapper = PartitionAnalysisEvent

FabricEvent.PartitionEvent

FabricEvent.PartitionEvent: CompositeMapper = PartitionEvent

FabricEvent.PartitionHealthReportExpired

FabricEvent.PartitionHealthReportExpired: CompositeMapper = PartitionHealthReportExpiredEvent

FabricEvent.PartitionNewHealthReport

FabricEvent.PartitionNewHealthReport: CompositeMapper = PartitionNewHealthReportEvent

FabricEvent.PartitionPrimaryMoveAnalysis

FabricEvent.PartitionPrimaryMoveAnalysis: CompositeMapper = PartitionPrimaryMoveAnalysisEvent

FabricEvent.PartitionReconfigured

FabricEvent.PartitionReconfigured: CompositeMapper = PartitionReconfiguredEvent

FabricEvent.ReplicaEvent

FabricEvent.ReplicaEvent: CompositeMapper = ReplicaEvent

FabricEvent.ServiceCreated

FabricEvent.ServiceCreated: CompositeMapper = ServiceCreatedEvent

FabricEvent.ServiceDeleted

FabricEvent.ServiceDeleted: CompositeMapper = ServiceDeletedEvent

FabricEvent.ServiceEvent

FabricEvent.ServiceEvent: CompositeMapper = ServiceEvent

FabricEvent.ServiceHealthReportExpired

FabricEvent.ServiceHealthReportExpired: CompositeMapper = ServiceHealthReportExpiredEvent

FabricEvent.ServiceNewHealthReport

FabricEvent.ServiceNewHealthReport: CompositeMapper = ServiceNewHealthReportEvent

FabricEvent.StatefulReplicaHealthReportExpired

FabricEvent.StatefulReplicaHealthReportExpired: CompositeMapper = StatefulReplicaHealthReportExpiredEvent

FabricEvent.StatefulReplicaNewHealthReport

FabricEvent.StatefulReplicaNewHealthReport: CompositeMapper = StatefulReplicaNewHealthReportEvent

FabricEvent.StatelessReplicaHealthReportExpired

FabricEvent.StatelessReplicaHealthReportExpired: CompositeMapper = StatelessReplicaHealthReportExpiredEvent

FabricEvent.StatelessReplicaNewHealthReport

FabricEvent.StatelessReplicaNewHealthReport: CompositeMapper = StatelessReplicaNewHealthReportEvent

HealthEvaluation

HealthEvaluation: CompositeMapper = HealthEvaluation

HealthEvaluation.Application

HealthEvaluation.Application: CompositeMapper = ApplicationHealthEvaluation

HealthEvaluation.ApplicationTypeApplications

HealthEvaluation.ApplicationTypeApplications: CompositeMapper = ApplicationTypeApplicationsHealthEvaluation

HealthEvaluation.Applications

HealthEvaluation.Applications: CompositeMapper = ApplicationsHealthEvaluation

HealthEvaluation.DeltaNodesCheck

HealthEvaluation.DeltaNodesCheck: CompositeMapper = DeltaNodesCheckHealthEvaluation

HealthEvaluation.DeployedApplication

HealthEvaluation.DeployedApplication: CompositeMapper = DeployedApplicationHealthEvaluation

HealthEvaluation.DeployedApplications

HealthEvaluation.DeployedApplications: CompositeMapper = DeployedApplicationsHealthEvaluation

HealthEvaluation.DeployedServicePackage

HealthEvaluation.DeployedServicePackage: CompositeMapper = DeployedServicePackageHealthEvaluation

HealthEvaluation.DeployedServicePackages

HealthEvaluation.DeployedServicePackages: CompositeMapper = DeployedServicePackagesHealthEvaluation

HealthEvaluation.Event

HealthEvaluation.Event: CompositeMapper = EventHealthEvaluation

HealthEvaluation.Node

HealthEvaluation.Node: CompositeMapper = NodeHealthEvaluation

HealthEvaluation.Nodes

HealthEvaluation.Nodes: CompositeMapper = NodesHealthEvaluation

HealthEvaluation.Partition

HealthEvaluation.Partition: CompositeMapper = PartitionHealthEvaluation

HealthEvaluation.Partitions

HealthEvaluation.Partitions: CompositeMapper = PartitionsHealthEvaluation

HealthEvaluation.Replica

HealthEvaluation.Replica: CompositeMapper = ReplicaHealthEvaluation

HealthEvaluation.Replicas

HealthEvaluation.Replicas: CompositeMapper = ReplicasHealthEvaluation

HealthEvaluation.Service

HealthEvaluation.Service: CompositeMapper = ServiceHealthEvaluation

HealthEvaluation.Services

HealthEvaluation.Services: CompositeMapper = ServicesHealthEvaluation

HealthEvaluation.SystemApplication

HealthEvaluation.SystemApplication: CompositeMapper = SystemApplicationHealthEvaluation

HealthEvaluation.UpgradeDomainDeltaNodesCheck

HealthEvaluation.UpgradeDomainDeltaNodesCheck: CompositeMapper = UpgradeDomainDeltaNodesCheckHealthEvaluation

HealthEvaluation.UpgradeDomainNodes

HealthEvaluation.UpgradeDomainNodes: CompositeMapper = UpgradeDomainNodesHealthEvaluation

NetworkResourcePropertiesBase

NetworkResourcePropertiesBase: CompositeMapper = NetworkResourcePropertiesBase

NetworkResourcePropertiesBase.Local

NetworkResourcePropertiesBase.Local: CompositeMapper = LocalNetworkResourceProperties

NetworkResourcePropertiesBase.NetworkResourceProperties

NetworkResourcePropertiesBase.NetworkResourceProperties: CompositeMapper = NetworkResourceProperties

PartitionInformation

PartitionInformation: CompositeMapper = PartitionInformation

PartitionInformation.Int64Range

PartitionInformation.Int64Range: CompositeMapper = Int64RangePartitionInformation

PartitionInformation.Named

PartitionInformation.Named: CompositeMapper = NamedPartitionInformation

PartitionInformation.Singleton

PartitionInformation.Singleton: CompositeMapper = SingletonPartitionInformation

PartitionSchemeDescription

PartitionSchemeDescription: CompositeMapper = PartitionSchemeDescription

PartitionSchemeDescription.Named

PartitionSchemeDescription.Named: CompositeMapper = NamedPartitionSchemeDescription

PartitionSchemeDescription.Singleton

PartitionSchemeDescription.Singleton: CompositeMapper = SingletonPartitionSchemeDescription

PartitionSchemeDescription.UniformInt64Range

PartitionSchemeDescription.UniformInt64Range: CompositeMapper = UniformInt64RangePartitionSchemeDescription

PropertyBatchInfo

PropertyBatchInfo: CompositeMapper = PropertyBatchInfo

PropertyBatchInfo.Failed

PropertyBatchInfo.Failed: CompositeMapper = FailedPropertyBatchInfo

PropertyBatchInfo.Successful

PropertyBatchInfo.Successful: CompositeMapper = SuccessfulPropertyBatchInfo

PropertyBatchOperation

PropertyBatchOperation: CompositeMapper = PropertyBatchOperation

PropertyBatchOperation.CheckExists

PropertyBatchOperation.CheckExists: CompositeMapper = CheckExistsPropertyBatchOperation

PropertyBatchOperation.CheckSequence

PropertyBatchOperation.CheckSequence: CompositeMapper = CheckSequencePropertyBatchOperation

PropertyBatchOperation.CheckValue

PropertyBatchOperation.CheckValue: CompositeMapper = CheckValuePropertyBatchOperation

PropertyBatchOperation.Delete

PropertyBatchOperation.Delete: CompositeMapper = DeletePropertyBatchOperation

PropertyBatchOperation.Get

PropertyBatchOperation.Get: CompositeMapper = GetPropertyBatchOperation

PropertyBatchOperation.Put

PropertyBatchOperation.Put: CompositeMapper = PutPropertyBatchOperation

PropertyValue

PropertyValue: CompositeMapper = PropertyValue

PropertyValue.Binary

PropertyValue.Binary: CompositeMapper = BinaryPropertyValue

PropertyValue.Double

PropertyValue.Double: CompositeMapper = DoublePropertyValue

PropertyValue.Guid

PropertyValue.Guid: CompositeMapper = GuidPropertyValue

PropertyValue.Int64

PropertyValue.Int64: CompositeMapper = Int64PropertyValue

PropertyValue.String

PropertyValue.String: CompositeMapper = StringPropertyValue

ProvisionApplicationTypeDescriptionBase

ProvisionApplicationTypeDescriptionBase: CompositeMapper = ProvisionApplicationTypeDescriptionBase

ProvisionApplicationTypeDescriptionBase.ExternalStore

ProvisionApplicationTypeDescriptionBase.ExternalStore: CompositeMapper = ExternalStoreProvisionApplicationTypeDescription

ProvisionApplicationTypeDescriptionBase.ImageStorePath

ProvisionApplicationTypeDescriptionBase.ImageStorePath: CompositeMapper = ProvisionApplicationTypeDescription

RepairImpactDescriptionBase

RepairImpactDescriptionBase: CompositeMapper = RepairImpactDescriptionBase

RepairImpactDescriptionBase.Node

RepairImpactDescriptionBase.Node: CompositeMapper = NodeRepairImpactDescription

RepairTargetDescriptionBase

RepairTargetDescriptionBase: CompositeMapper = RepairTargetDescriptionBase

RepairTargetDescriptionBase.Node

RepairTargetDescriptionBase.Node: CompositeMapper = NodeRepairTargetDescription

ReplicaInfo

ReplicaInfo: CompositeMapper = ReplicaInfo

ReplicaInfo.Stateful

ReplicaInfo.Stateful: CompositeMapper = StatefulServiceReplicaInfo

ReplicaInfo.Stateless

ReplicaInfo.Stateless: CompositeMapper = StatelessServiceInstanceInfo

ReplicaStatusBase

ReplicaStatusBase: CompositeMapper = ReplicaStatusBase

ReplicaStatusBase.KeyValueStore

ReplicaStatusBase.KeyValueStore: CompositeMapper = KeyValueStoreReplicaStatus

ReplicatorStatus

ReplicatorStatus: CompositeMapper = ReplicatorStatus

ReplicatorStatus.ActiveSecondary

ReplicatorStatus.ActiveSecondary: CompositeMapper = SecondaryActiveReplicatorStatus

ReplicatorStatus.IdleSecondary

ReplicatorStatus.IdleSecondary: CompositeMapper = SecondaryIdleReplicatorStatus

ReplicatorStatus.Primary

ReplicatorStatus.Primary: CompositeMapper = PrimaryReplicatorStatus

ReplicatorStatus.SecondaryReplicatorStatus

ReplicatorStatus.SecondaryReplicatorStatus: CompositeMapper = SecondaryReplicatorStatus

RetentionPolicyDescription

RetentionPolicyDescription: CompositeMapper = RetentionPolicyDescription

RetentionPolicyDescription.Basic

RetentionPolicyDescription.Basic: CompositeMapper = BasicRetentionPolicyDescription

SafetyCheck

SafetyCheck: CompositeMapper = SafetyCheck

SafetyCheck.EnsureAvailability

SafetyCheck.EnsureAvailability: CompositeMapper = EnsureAvailabilitySafetyCheck

SafetyCheck.EnsurePartitionQuorum

SafetyCheck.EnsurePartitionQuorum: CompositeMapper = EnsurePartitionQuorumSafetyCheck

SafetyCheck.EnsureSeedNodeQuorum

SafetyCheck.EnsureSeedNodeQuorum: CompositeMapper = SeedNodeSafetyCheck

SafetyCheck.PartitionSafetyCheck

SafetyCheck.PartitionSafetyCheck: CompositeMapper = PartitionSafetyCheck

SafetyCheck.WaitForInbuildReplica

SafetyCheck.WaitForInbuildReplica: CompositeMapper = WaitForInbuildReplicaSafetyCheck

SafetyCheck.WaitForPrimaryPlacement

SafetyCheck.WaitForPrimaryPlacement: CompositeMapper = WaitForPrimaryPlacementSafetyCheck

SafetyCheck.WaitForPrimarySwap

SafetyCheck.WaitForPrimarySwap: CompositeMapper = WaitForPrimarySwapSafetyCheck

SafetyCheck.WaitForReconfiguration

SafetyCheck.WaitForReconfiguration: CompositeMapper = WaitForReconfigurationSafetyCheck

ScalingMechanismDescription

ScalingMechanismDescription: CompositeMapper = ScalingMechanismDescription

ScalingMechanismDescription.AddRemoveIncrementalNamedPartition

ScalingMechanismDescription.AddRemoveIncrementalNamedPartition: CompositeMapper = AddRemoveIncrementalNamedPartitionScalingMechanism

ScalingMechanismDescription.PartitionInstanceCount

ScalingMechanismDescription.PartitionInstanceCount: CompositeMapper = PartitionInstanceCountScaleMechanism

ScalingTriggerDescription

ScalingTriggerDescription: CompositeMapper = ScalingTriggerDescription

ScalingTriggerDescription.AveragePartitionLoad

ScalingTriggerDescription.AveragePartitionLoad: CompositeMapper = AveragePartitionLoadScalingTrigger

ScalingTriggerDescription.AverageServiceLoad

ScalingTriggerDescription.AverageServiceLoad: CompositeMapper = AverageServiceLoadScalingTrigger

SecretResourcePropertiesBase

SecretResourcePropertiesBase: CompositeMapper = SecretResourcePropertiesBase

SecretResourcePropertiesBase.SecretResourceProperties

SecretResourcePropertiesBase.SecretResourceProperties: CompositeMapper = SecretResourceProperties

SecretResourcePropertiesBase.inlinedValue

SecretResourcePropertiesBase.inlinedValue: CompositeMapper = InlinedValueSecretResourceProperties

ServiceDescription

ServiceDescription: CompositeMapper = ServiceDescription

ServiceDescription.Stateful

ServiceDescription.Stateful: CompositeMapper = StatefulServiceDescription

ServiceDescription.Stateless

ServiceDescription.Stateless: CompositeMapper = StatelessServiceDescription

ServiceInfo

ServiceInfo: CompositeMapper = ServiceInfo

ServiceInfo.Stateful

ServiceInfo.Stateful: CompositeMapper = StatefulServiceInfo

ServiceInfo.Stateless

ServiceInfo.Stateless: CompositeMapper = StatelessServiceInfo

ServicePartitionInfo

ServicePartitionInfo: CompositeMapper = ServicePartitionInfo

ServicePartitionInfo.Stateful

ServicePartitionInfo.Stateful: CompositeMapper = StatefulServicePartitionInfo

ServicePartitionInfo.Stateless

ServicePartitionInfo.Stateless: CompositeMapper = StatelessServicePartitionInfo

ServicePlacementPolicyDescription

ServicePlacementPolicyDescription: CompositeMapper = ServicePlacementPolicyDescription

ServicePlacementPolicyDescription.InvalidDomain

ServicePlacementPolicyDescription.InvalidDomain: CompositeMapper = ServicePlacementInvalidDomainPolicyDescription

ServicePlacementPolicyDescription.NonPartiallyPlaceService

ServicePlacementPolicyDescription.NonPartiallyPlaceService: CompositeMapper = ServicePlacementNonPartiallyPlaceServicePolicyDescription

ServicePlacementPolicyDescription.PreferPrimaryDomain

ServicePlacementPolicyDescription.PreferPrimaryDomain: CompositeMapper = ServicePlacementPreferPrimaryDomainPolicyDescription

ServicePlacementPolicyDescription.RequireDomain

ServicePlacementPolicyDescription.RequireDomain: CompositeMapper = ServicePlacementRequiredDomainPolicyDescription

ServicePlacementPolicyDescription.RequireDomainDistribution

ServicePlacementPolicyDescription.RequireDomainDistribution: CompositeMapper = ServicePlacementRequireDomainDistributionPolicyDescription

ServiceTypeDescription

ServiceTypeDescription: CompositeMapper = ServiceTypeDescription

ServiceTypeDescription.Stateful

ServiceTypeDescription.Stateful: CompositeMapper = StatefulServiceTypeDescription

ServiceTypeDescription.Stateless

ServiceTypeDescription.Stateless: CompositeMapper = StatelessServiceTypeDescription

ServiceUpdateDescription

ServiceUpdateDescription: CompositeMapper = ServiceUpdateDescription

ServiceUpdateDescription.Stateful

ServiceUpdateDescription.Stateful: CompositeMapper = StatefulServiceUpdateDescription

ServiceUpdateDescription.Stateless

ServiceUpdateDescription.Stateless: CompositeMapper = StatelessServiceUpdateDescription

Const enabled

enabled: object

parameterPath

parameterPath: string = "enabled"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "Enabled"

type

type: object

name

name: "Boolean" = "Boolean"

Const endDateTimeFilter

endDateTimeFilter: object

parameterPath

parameterPath: string[] = ["options","endDateTimeFilter"]

mapper

mapper: object

serializedName

serializedName: string = "EndDateTimeFilter"

type

type: object

name

name: "DateTime" = "DateTime"

Const endTimeUtc0

endTimeUtc0: object

parameterPath

parameterPath: string[] = ["options","endTimeUtc"]

mapper

mapper: object

serializedName

serializedName: string = "EndTimeUtc"

type

type: object

name

name: "String" = "String"

Const endTimeUtc1

endTimeUtc1: object

parameterPath

parameterPath: string = "endTimeUtc"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "EndTimeUtc"

type

type: object

name

name: "String" = "String"

Const eventInstanceId

eventInstanceId: object

parameterPath

parameterPath: string = "eventInstanceId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "eventInstanceId"

type

type: object

name

name: "String" = "String"

Const eventsHealthStateFilter

eventsHealthStateFilter: object

parameterPath

parameterPath: string[] = ["options","eventsHealthStateFilter"]

mapper

mapper: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "EventsHealthStateFilter"

type

type: object

name

name: "Number" = "Number"

Const eventsTypesFilter

eventsTypesFilter: object

parameterPath

parameterPath: string[] = ["options","eventsTypesFilter"]

mapper

mapper: object

serializedName

serializedName: string = "EventsTypesFilter"

type

type: object

name

name: "String" = "String"

Const excludeAnalysisEvents

excludeAnalysisEvents: object

parameterPath

parameterPath: string[] = ["options","excludeAnalysisEvents"]

mapper

mapper: object

serializedName

serializedName: string = "ExcludeAnalysisEvents"

type

type: object

name

name: "Boolean" = "Boolean"

Const excludeApplicationParameters

excludeApplicationParameters: object

parameterPath

parameterPath: string[] = ["options","excludeApplicationParameters"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "ExcludeApplicationParameters"

type

type: object

name

name: "Boolean" = "Boolean"

Const excludeHealthStatistics

excludeHealthStatistics: object

parameterPath

parameterPath: string[] = ["options","excludeHealthStatistics"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "ExcludeHealthStatistics"

type

type: object

name

name: "Boolean" = "Boolean"

Const executorFilter

executorFilter: object

parameterPath

parameterPath: string[] = ["options","executorFilter"]

mapper

mapper: object

serializedName

serializedName: string = "ExecutorFilter"

type

type: object

name

name: "String" = "String"

Const force

force: object

parameterPath

parameterPath: string = "force"

mapper

mapper: object

defaultValue

defaultValue: boolean = false

required

required: true = true

serializedName

serializedName: string = "Force"

type

type: object

name

name: "Boolean" = "Boolean"

Const forceRemove

forceRemove: object

parameterPath

parameterPath: string[] = ["options","forceRemove"]

mapper

mapper: object

serializedName

serializedName: string = "ForceRemove"

type

type: object

name

name: "Boolean" = "Boolean"

Const gatewayResourceName

gatewayResourceName: object

parameterPath

parameterPath: string = "gatewayResourceName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "gatewayResourceName"

type

type: object

name

name: "String" = "String"

Const ignoreConstraints

ignoreConstraints: object

parameterPath

parameterPath: string[] = ["options","ignoreConstraints"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "IgnoreConstraints"

type

type: object

name

name: "Boolean" = "Boolean"

Const immediate

immediate: object

parameterPath

parameterPath: string[] = ["options","immediate"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "Immediate"

type

type: object

name

name: "Boolean" = "Boolean"

Const includeHealthState

includeHealthState: object

parameterPath

parameterPath: string[] = ["options","includeHealthState"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "IncludeHealthState"

type

type: object

name

name: "Boolean" = "Boolean"

Const includeSystemApplicationHealthStatistics

includeSystemApplicationHealthStatistics: object

parameterPath

parameterPath: string[] = ["options","includeSystemApplicationHealthStatistics"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "IncludeSystemApplicationHealthStatistics"

type

type: object

name

name: "Boolean" = "Boolean"

Const includeValues

includeValues: object

parameterPath

parameterPath: string[] = ["options","includeValues"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "IncludeValues"

type

type: object

name

name: "Boolean" = "Boolean"

Const latest

latest: object

parameterPath

parameterPath: string[] = ["options","latest"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "Latest"

type

type: object

name

name: "Boolean" = "Boolean"

Const maxResults

maxResults: object

parameterPath

parameterPath: string[] = ["options","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "MaxResults"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

Const nameId

nameId: object

parameterPath

parameterPath: string = "nameId"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nameId"

type

type: object

name

name: "String" = "String"

Const networkResourceName

networkResourceName: object

parameterPath

parameterPath: string = "networkResourceName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "networkResourceName"

type

type: object

name

name: "String" = "String"

Const newNodeName

newNodeName: object

parameterPath

parameterPath: string[] = ["options","newNodeName"]

mapper

mapper: object

serializedName

serializedName: string = "NewNodeName"

type

type: object

name

name: "String" = "String"

Const nodeInstanceId

nodeInstanceId: object

parameterPath

parameterPath: string = "nodeInstanceId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "NodeInstanceId"

type

type: object

name

name: "String" = "String"

Const nodeName0

nodeName0: object

parameterPath

parameterPath: string = "nodeName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nodeName"

type

type: object

name

name: "String" = "String"

Const nodeName1

nodeName1: object

parameterPath

parameterPath: string[] = ["options","nodeName"]

mapper

mapper: object

serializedName

serializedName: string = "NodeName"

type

type: object

name

name: "String" = "String"

Const nodeStatusFilter

nodeStatusFilter: object

parameterPath

parameterPath: string[] = ["options","nodeStatusFilter"]

mapper

mapper: object

defaultValue

defaultValue: string = "default"

serializedName

serializedName: string = "NodeStatusFilter"

type

type: object

name

name: "String" = "String"

Const nodeTransitionType

nodeTransitionType: object

parameterPath

parameterPath: string = "nodeTransitionType"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "NodeTransitionType"

type

type: object

name

name: "String" = "String"

Const nodesHealthStateFilter

nodesHealthStateFilter: object

parameterPath

parameterPath: string[] = ["options","nodesHealthStateFilter"]

mapper

mapper: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "NodesHealthStateFilter"

type

type: object

name

name: "Number" = "Number"

Const onlyQueryPrimaries

onlyQueryPrimaries: object

parameterPath

parameterPath: string[] = ["options","onlyQueryPrimaries"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "OnlyQueryPrimaries"

type

type: object

name

name: "Boolean" = "Boolean"

Const operationId

operationId: object

parameterPath

parameterPath: string = "operationId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "OperationId"

type

type: object

name

name: "Uuid" = "Uuid"

Const partitionId0

partitionId0: object

parameterPath

parameterPath: string[] = ["options","partitionId"]

mapper

mapper: object

serializedName

serializedName: string = "PartitionId"

type

type: object

name

name: "Uuid" = "Uuid"

Const partitionId1

partitionId1: object

parameterPath

parameterPath: string = "partitionId"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "partitionId"

type

type: object

name

name: "Uuid" = "Uuid"

Const partitionKeyType

partitionKeyType: object

parameterPath

parameterPath: string[] = ["options","partitionKeyType"]

mapper

mapper: object

serializedName

serializedName: string = "PartitionKeyType"

type

type: object

name

name: "Number" = "Number"

Const partitionKeyValue

partitionKeyValue: object

parameterPath

parameterPath: string[] = ["options","partitionKeyValue"]

skipEncoding

skipEncoding: true = true

mapper

mapper: object

serializedName

serializedName: string = "PartitionKeyValue"

type

type: object

name

name: "String" = "String"

Const partitionsHealthStateFilter

partitionsHealthStateFilter: object

parameterPath

parameterPath: string[] = ["options","partitionsHealthStateFilter"]

mapper

mapper: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "PartitionsHealthStateFilter"

type

type: object

name

name: "Number" = "Number"

Const previous

previous: object

parameterPath

parameterPath: string[] = ["options","previous"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "Previous"

type

type: object

name

name: "Boolean" = "Boolean"

Const previousRspVersion

previousRspVersion: object

parameterPath

parameterPath: string[] = ["options","previousRspVersion"]

skipEncoding

skipEncoding: true = true

mapper

mapper: object

serializedName

serializedName: string = "PreviousRspVersion"

type

type: object

name

name: "String" = "String"

Const propertyName

propertyName: object

parameterPath

parameterPath: string = "propertyName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "PropertyName"

type

type: object

name

name: "String" = "String"

Const quorumLossDuration

quorumLossDuration: object

parameterPath

parameterPath: string = "quorumLossDuration"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "QuorumLossDuration"

type

type: object

name

name: "Number" = "Number"

Const quorumLossMode

quorumLossMode: object

parameterPath

parameterPath: string = "quorumLossMode"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "QuorumLossMode"

type

type: object

name

name: "String" = "String"

Const recursive

recursive: object

parameterPath

parameterPath: string[] = ["options","recursive"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "Recursive"

type

type: object

name

name: "Boolean" = "Boolean"

Const replicaId

replicaId: object

parameterPath

parameterPath: string = "replicaId"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "replicaId"

type

type: object

name

name: "String" = "String"

Const replicaName

replicaName: object

parameterPath

parameterPath: string = "replicaName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "replicaName"

type

type: object

name

name: "String" = "String"

Const replicasHealthStateFilter

replicasHealthStateFilter: object

parameterPath

parameterPath: string[] = ["options","replicasHealthStateFilter"]

mapper

mapper: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "ReplicasHealthStateFilter"

type

type: object

name

name: "Number" = "Number"

Const restartPartitionMode

restartPartitionMode: object

parameterPath

parameterPath: string = "restartPartitionMode"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "RestartPartitionMode"

type

type: object

name

name: "String" = "String"

Const restoreTimeout

restoreTimeout: object

parameterPath

parameterPath: string[] = ["options","restoreTimeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 10

serializedName

serializedName: string = "RestoreTimeout"

type

type: object

name

name: "Number" = "Number"

Const secretResourceName

secretResourceName: object

parameterPath

parameterPath: string = "secretResourceName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "secretResourceName"

type

type: object

name

name: "String" = "String"

Const secretValueResourceName

secretValueResourceName: object

parameterPath

parameterPath: string = "secretValueResourceName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "secretValueResourceName"

type

type: object

name

name: "String" = "String"

Const serviceId0

serviceId0: object

parameterPath

parameterPath: string = "serviceId"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "serviceId"

type

type: object

name

name: "String" = "String"

Const serviceId1

serviceId1: object

parameterPath

parameterPath: string[] = ["options","serviceId"]

mapper

mapper: object

serializedName

serializedName: string = "ServiceId"

type

type: object

name

name: "String" = "String"

Const serviceKind

serviceKind: object

parameterPath

parameterPath: string = "serviceKind"

mapper

mapper: object

defaultValue

defaultValue: string = "Stateful"

required

required: true = true

serializedName

serializedName: string = "ServiceKind"

type

type: object

name

name: "String" = "String"

Const serviceManifestName0

serviceManifestName0: object

parameterPath

parameterPath: string = "serviceManifestName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "ServiceManifestName"

type

type: object

name

name: "String" = "String"

Const serviceManifestName1

serviceManifestName1: object

parameterPath

parameterPath: string[] = ["options","serviceManifestName"]

mapper

mapper: object

serializedName

serializedName: string = "ServiceManifestName"

type

type: object

name

name: "String" = "String"

Const servicePackageName

servicePackageName: object

parameterPath

parameterPath: string = "servicePackageName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "servicePackageName"

type

type: object

name

name: "String" = "String"

Const serviceResourceName

serviceResourceName: object

parameterPath

parameterPath: string = "serviceResourceName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "serviceResourceName"

type

type: object

name

name: "String" = "String"

Const serviceTypeName0

serviceTypeName0: object

parameterPath

parameterPath: string = "serviceTypeName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "serviceTypeName"

type

type: object

name

name: "String" = "String"

Const serviceTypeName1

serviceTypeName1: object

parameterPath

parameterPath: string[] = ["options","serviceTypeName"]

mapper

mapper: object

serializedName

serializedName: string = "ServiceTypeName"

type

type: object

name

name: "String" = "String"

Const servicesHealthStateFilter

servicesHealthStateFilter: object

parameterPath

parameterPath: string[] = ["options","servicesHealthStateFilter"]

mapper

mapper: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "ServicesHealthStateFilter"

type

type: object

name

name: "Number" = "Number"

Const sessionId

sessionId: object

parameterPath

parameterPath: string = "sessionId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "session-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const skipCorrelationLookup

skipCorrelationLookup: object

parameterPath

parameterPath: string[] = ["options","skipCorrelationLookup"]

mapper

mapper: object

serializedName

serializedName: string = "SkipCorrelationLookup"

type

type: object

name

name: "Boolean" = "Boolean"

Const startDateTimeFilter

startDateTimeFilter: object

parameterPath

parameterPath: string[] = ["options","startDateTimeFilter"]

mapper

mapper: object

serializedName

serializedName: string = "StartDateTimeFilter"

type

type: object

name

name: "DateTime" = "DateTime"

Const startTimeUtc0

startTimeUtc0: object

parameterPath

parameterPath: string[] = ["options","startTimeUtc"]

mapper

mapper: object

serializedName

serializedName: string = "StartTimeUtc"

type

type: object

name

name: "String" = "String"

Const startTimeUtc1

startTimeUtc1: object

parameterPath

parameterPath: string = "startTimeUtc"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "StartTimeUtc"

type

type: object

name

name: "String" = "String"

Const stateFilter0

stateFilter0: object

parameterPath

parameterPath: string[] = ["options","stateFilter"]

mapper

mapper: object

serializedName

serializedName: string = "StateFilter"

type

type: object

name

name: "Number" = "Number"

Const stateFilter1

stateFilter1: object

parameterPath

parameterPath: string = "stateFilter"

mapper

mapper: object

defaultValue

defaultValue: number = 65535

required

required: true = true

serializedName

serializedName: string = "StateFilter"

type

type: object

name

name: "Number" = "Number"

Const stopDurationInSeconds

stopDurationInSeconds: object

parameterPath

parameterPath: string = "stopDurationInSeconds"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "StopDurationInSeconds"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

Const tail

tail: object

parameterPath

parameterPath: string[] = ["options","tail"]

mapper

mapper: object

serializedName

serializedName: string = "Tail"

type

type: object

name

name: "String" = "String"

Const taskIdFilter

taskIdFilter: object

parameterPath

parameterPath: string[] = ["options","taskIdFilter"]

mapper

mapper: object

serializedName

serializedName: string = "TaskIdFilter"

type

type: object

name

name: "String" = "String"

Const timeout

timeout: object

parameterPath

parameterPath: string[] = ["options","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 60

serializedName

serializedName: string = "timeout"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 4294967295

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const typeFilter

typeFilter: object

parameterPath

parameterPath: string = "typeFilter"

mapper

mapper: object

defaultValue

defaultValue: number = 65535

required

required: true = true

serializedName

serializedName: string = "TypeFilter"

type

type: object

name

name: "Number" = "Number"

Const volumeResourceName

volumeResourceName: object

parameterPath

parameterPath: string = "volumeResourceName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "volumeResourceName"

type

type: object

name

name: "String" = "String"

Generated using TypeDoc